Create a user

Creates a person on your account — disabled to begin with — together with their group, extension and account assignments and their language and timezone settings, then emails them a link that lets them set a password for the next 48 hours. You cannot grant a group that outranks your own API key. The writes run in sequence and are not transactional, so a failure partway through can leave a partially created person. Requires an API key with the Admin role.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Given name; used to build the person's names and not separately checked for emptiness.

string
required

Family name; used to build the person's names.

string

Name shown in the interface; omitting it stores null.

string
required

Sign-in name, also used as the person's email address.

string

Mobile number; omitting it or sending an empty value stores null.

string
enum
required

Interface language, en-us or fr-ca; it must be present for the settings to be written, and the value itself is not checked.

Allowed:
string
required

The person's timezone; it must be present.

string
required

Group IDs to assign within defaultDomainId; at least one is required, and you cannot grant a group that outranks your own API key.

string

Extension IDs to assign within defaultDomainId; an empty array or omitting it assigns none.

string
required

Account IDs the person is assigned to; at least one is required, and the list is written as sent.

string
required

The person's default account, and the account their groups and extensions are assigned within.

string

Avatar to show for the person; omitting it or sending an empty value stores null.

Responses

401

Missing or invalid API key.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json