Skip to main content
PATCH
Update an agent

Authorizations

Authorization
string
header
required

Workspace API token created in Settings → API. Tokens start with adraa_.

Path Parameters

agentId
string
required

ID of the agent. List agents with GET /api/v1/agents to find it.

Example:

"cmbxgwq1e0000ph01i0j1k2l3"

Body

application/json
nickname
string

New display name, unique across Adraa Inbox.

Maximum string length: 60
Example:

"sara"

role
enum<string>

New workspace role.

Available options:
agent,
admin

Response

The updated agent

agent
object