Skip to main content
POST
Create Agent

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