API Reference

Update a custom role.

put
https://app.customgpt.ai/api/v1/teams/roles/

Updates an existing custom role's name, description, and permissions. Only roles belonging to this team can be updated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required

The unique role identifier.

Body Params

Create or update a custom team role

string
length ≤ 255

Role name. Cannot match a reserved system role name. Max 255 characters.

string
length ≤ 255

Description of the role. Max 255 characters.

string
enum

Role scope. Use local to restrict access to specific agents; use global to grant access to all team agents.

Allowed:
boolean
Defaults to false

When true, members with this role can only use chat. The permissions field is ignored and set automatically.

permissions
array of strings

Permission names to grant to this role. Ignored when is_chat_only is true. Omit or pass an empty array for no permissions.

permissions
agents
array of integers

Agent IDs this role grants access to. Required when type is local.

agents
boolean
Defaults to false

Whether members with this role can create new agents.

Responses

Updated about 1 hour ago

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 hour ago