Skip to main content
POST
/
api
/
v1
/
agents
Add an agent
curl --request POST \
  --url https://api.inbox.adraa.ai/api/v1/agents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "nickname": "sara",
  "role": "agent"
}
'
{ "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_.

Body

application/json
​
email
string<email>
required

The agent's sign-in email.

Example:

"[email protected]"

​
nickname
string

Display name, unique across Adraa Inbox. Generated from the email when omitted. Ignored if the email already has an account.

Maximum string length: 60
Example:

"sara"

​
role
enum<string>
default:agent

Workspace role.

Available options:
agent,
admin

Response

Agent added to the workspace

​
agent
object