API ReferenceSecurity

Update Business Role

Send property change sets using the same pattern as other workspace batch-update APIs. For permissions, include a permissions property with a partial or full permissions object; omitted keys are merged with the current role. Keys may use the same names as GET `permissions` (e.g. `editUsers`) or RetrieveMe / POST-create style (e.g. `editUser`). The response body matches create when successful.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

roleIdstringRequiredformat: "uuid"
Business role identifier.

Headers

x-integration-namestringOptional
The name of the calling system passed along as a header parameter

Request

List of property name and value pairs to apply.
propertystringOptional

Field to change: name, description, or permissions.

valueany or nullOptional

New value for the field; for permissions, a JSON object in the role permissions matrix shape.

idstring or nullOptionalformat: "uuid"
Optional identifier when the change targets a nested or keyed item.

Response

Success
errorobject or null
If the API call failed, this will contain information about the error that occurred.
successbooleanRead-only

True if the API call succeeded; false otherwise.

hasErrorbooleanRead-only
True if the API call failed.
statusCodeenum
The HTTP code of the response.
dataobject

Workspace business role returned by the data API security endpoints (list/update responses and create response).