STstuut
roles

Update a Role

Updates a custom role's name, permissions, or visibility scope. System roles cannot be modified.

patch/v2/roles/{role_id}

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

role_idstring required

Request body

namestring nullable
permissionsstring[] nullable
data_visibility_scope'organization' | 'business_units' | 'assigned_only'
work_visibility_scope'organization' | 'business_units' | 'assigned_only'

Response

Successful Response

idstring required
slugstring required
namestring required
permissionsstring[] required
permissions_expandedstring[] required
data_visibility_scope'organization' | 'business_units' | 'assigned_only' required
work_visibility_scope'organization' | 'business_units' | 'assigned_only' required
is_systemboolean required
active_member_countinteger required
deactivated_member_countinteger required

Changes

No recorded changes to this operation across all 2 revisions of this API.