Update role

Update a role. Use denied_permissions to narrow a built-in role (denials win over baseline grants, including wildcards). Superuser roles cannot have denials.

Authorization

authorization

AuthorizationBearer <token>

In: header

Path Parameters

role_id*string

Role ID

Request Body

application/json

Role params

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for updating a role

denied_permissions?array<string>

Permissions to explicitly deny for this role. Replaces the existing denial list. Denials win over grants, including wildcards. Pass an empty array to clear denials. Cannot be set on superuser roles.

name?string

The role's display name.

permissions?array<string>

Allow-list of permissions for custom roles only. Built-in roles (superuser, admin, staff) reject updates to this field; their grants are defined by type.

Response Body

`application/json`

curl -X PATCH "https://example.com/v1/roles/string" \  -H "Content-Type: application/json" \  -d '{    "denied_permissions": [      "appointments.own.cancel",      "appointments.own.reschedule"    ]  }'

{  "data": {    "denied_permissions": [      "appointments.own.cancel",      "appointments.own.reschedule"    ],    "id": "role_123456789012",    "name": "Staff",    "object": "role",    "permissions": [      "accounts.view",      "appointments.own.*",      "blocks.*",      "booking_intents.*",      "clients.*",      "integrations.own.*",      "providers.own.view",      "providers.own.update"    ],    "type": "staff"  }}

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`