Change a Role's name, description, Capabilities or availability

PATCH/api/v1/roles/{roleId}

Requires an Organization API key with the manageMembers capability.

Authorization

apiKey

AuthorizationBearer <token>

In: header

Path Parameters

roleId*string

Request Body

application/json

name?string

description?string

capabilities?array<string>

organizationLevel?boolean

assistantLevel?boolean

Response Body

`application/json`

curl -X PATCH "https://example.com/api/v1/roles/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "builtIn": true,  "edited": true,  "locked": true,  "id": "string",  "organizationId": "string",  "key": null,  "name": "string",  "description": "string",  "capabilities": [    "string"  ],  "organizationLevel": true,  "assistantLevel": true,  "tier": "owner",  "memberCount": 0,  "apiKeyCount": 0,  "inviteCount": 0,  "assistantGrantCount": 0,  "memberDefault": true,  "assistantDefault": true,  "createdAt": "string",  "updatedAt": "string"}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

Change a Role's name, description, Capabilities or availability

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`