curl --request POST \
--url http://localhost:8080/api/v1/agents \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"first_name": "<string>",
"last_name": "<string>",
"email": "[email protected]",
"send_welcome_email": true,
"teams": [
"<string>"
],
"enabled": true,
"role": "<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_calling_code": "+1",
"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"
}
}
curl --request POST \
--url http://localhost:8080/api/v1/agents \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '{
"first_name": "<string>",
"last_name": "<string>",
"email": "[email protected]",
"send_welcome_email": true,
"teams": [
"<string>"
],
"enabled": true,
"role": "<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_calling_code": "+1",
"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"
}
}
Basic authentication using base64 encoded API key and secret. Format: Authorization: Basic <base64(api_key:api_secret)>
Agent creation details
The body is of type object
.
Agent created successfully
The response is of type object
.
Was this page helpful?