Skip to main content
PATCH
/
api
/
v1
/
agents
/
{agentId}
Update an agent
curl --request PATCH \
  --url https://api.inbox.adraa.ai/api/v1/agents/{agentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "nickname": "sara"
}
'
{
  "agent": {
    "id": "cmbxgwq1e0000ph01i0j1k2l3",
    "email": "[email protected]",
    "nickname": "sara",
    "role": "agent",
    "isOnline": true,
    "lastSeen": "2026-06-12T10:25:00.000Z",
    "createdAt": "2026-05-02T08:14:00.000Z"
  }
}

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