Skip to main content
POST
Create user

Authorizations

api_access_token
string
header
required

API access token authentication

Headers

account-id
string<uuid>
required

Account ID (required)

Body

application/json
name
string
required

User full name

Minimum string length: 1
email
string<email>
required

User email address

password
string

User password (optional, will be auto-generated if not provided)

Minimum string length: 8
role
enum<string>

User role

Available options:
administrator,
agent
availability
enum<string>

User availability status

Available options:
online,
offline,
busy
auto_offline
boolean

Whether user should be automatically set to offline

custom_attributes
object

Custom user attributes

Response

User created successfully

success
boolean
Example:

true

data
object
message
string