Skip to main content
POST
Create a User

Authorizations

api_access_token
string
header
required

This token can be obtained by the system admin after creating a platformApp. This token should be used to provision agent bots, accounts, users and their roles.

Body

application/json
name
string

Name of the user

Example:

"Daniel"

display_name
string

Display name of the user

Example:

"Dan"

email
string

Email of the user

Example:

"daniel@acme.inc"

password
string

Password must contain uppercase, lowercase letters, number and a special character

Example:

"Password2!"

custom_attributes
object

Custom attributes you want to associate with the user

Example:

Response

Success

id
number
access_token
string
account_id
number
available_name
string
avatar_url
string
confirmed
boolean
display_name
string | null
message_signature
string | null
email
string
hmac_identifier
string
inviter_id
number
name
string
provider
string
pubsub_token
string
role
enum<string>
Available options:
agent,
administrator
ui_settings
object
uid
string
type
string | null
custom_attributes
object

Available for users who are created through platform APIs and has custom attributes associated.

accounts
object[]