Skip to main content
PATCH
Update Custom Role

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Path Parameters

role_id
string
required

The unique identifier of the role (a system role ID or a custom role ID)

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Body

application/json

Request body for updating a custom role's permissions

permissions
object
required

Per-category access levels for a role. Every category is at least 'view'; categories omitted on create/update default to 'view'.

Response

Role updated successfully

success
boolean
required
Example:

true

role
object
required

A role available in your organization — a built-in system role or a custom role.