Skip to main content
POST
/
api
/
v1
/
agents
Create Agent
curl --request POST \
  --url http://localhost:8080/api/v1/agents \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "email": "[email protected]",
  "roles": [
    "<string>"
  ],
  "last_name": "<string>",
  "send_welcome_email": true,
  "teams": [
    "<string>"
  ],
  "enabled": true,
  "availability_status": "online",
  "new_password": "<string>"
}
'
{
  "status": "success",
  "data": {
    "id": 1,
    "created_at": "2025-08-28T10:00:00Z",
    "updated_at": "2025-08-28T10:00:00Z",
    "first_name": "John",
    "last_name": "Doe",
    "email": "[email protected]",
    "type": "agent",
    "availability_status": "online",
    "phone_number_country_code": "US",
    "phone_number": "1234567890",
    "avatar_url": "/avatars/agent1.jpg",
    "enabled": true,
    "last_active_at": "2025-08-28T10:00:00Z",
    "last_login_at": "2025-08-28T10:00:00Z",
    "roles": [
      "admin"
    ],
    "permissions": [
      "conversations:read"
    ],
    "custom_attributes": {},
    "teams": [
      {
        "id": 1,
        "name": "Support Team",
        "emoji": "🛠️"
      }
    ],
    "api_key": "<string>",
    "api_key_last_used_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>

Body

application/json

Agent creation details

​
first_name
string
required

Agent's first name

​
email
string<email>
required

Agent's email address

​
roles
string[]
required

Roles assigned to the agent

​
last_name
string

Agent's last name

​
send_welcome_email
boolean

Only used during agent creation to send welcome email

​
teams
string[]

Team IDs to assign agent to

​
enabled
boolean

Whether agent is enabled

​
availability_status
enum<string>

Agent's availability status

Available options:
online,
away,
away_manual,
offline,
away_and_reassigning
​
new_password
string

Agent's new password, Optional

Response

Agent created successfully

​
status
string
Example:

"success"

​
data
object