Partially update a role

patch

https://{buzz_key}.api.beeswax.com/rest/v2/roles/{id}

Update one or more fields of a role.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

Unique ID of the role

Body Params

account_id

integer | null

The account associated with the role. Defaults to the current account.

alternative_id

string | null

An ID that may be used for any reporting or administrative purpose. Limited to 191 characters.

dashboard_ids

array

List of dashboard IDs users associated with this role should be able to access

dashboard_ids

name

string

notes

string | null

Free-form notes of up to 255 characters.

parent_role_id

integer

permissions

array of objects

Object containing resource-level permissions for this Role

permissions

report_field_group_ids

array

List of report field group IDs users associated with this role should be able to access

report_field_group_ids

report_ids

array of integers

List of IDs of reports users associated with this role should be able to access. A list of reports may be queried using /reporting/reports.

report_ids

shared_across_accounts

boolean

Defaults to false

Responses

400

Invalid data.

404

Role not found.

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

200