Create User

Creates a new user and returns the created record.

When to use. Add a user to your account. If a user with the same username already exists, that existing user is returned and no new user is created.

Required fields. username, email and sip_option.

Notes. If you omit password, a temporary password is generated for the user. When sip_option is set to Custom URI, sip_uri is required. You can also assign roles and desks by passing their IDs. See the request schema for the full list of accepted fields.

Returns. 201 Created with { "users": [ { ... } ] }.

Example.

{
  "username": "jsmith",
  "email": "[email protected]",
  "sip_option": 0
}
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body for creating a user. username, email and sip_option are mandatory.

string
required

Username.

string
required

Email address.

string

Password for the user account.

integer
required

SIP option (0 - WebRTC, 2 - Custom URI (needs sip_uri), 3 - Built in PBX).

integer

Whether the user is active (1/0).

date-time

Timestamp the user clocked in.

string

SIP URI (required when sip_option is Custom URI).

integer

Auto-dial status (1/0).

integer

Whether the user is deleted (1/0).

integer

Use extended IP ACL (1 - yes, 0 - no).

date-time

Timestamp the user clocked in for predictive dialing.

string

Predictive dynamic extension.

integer

Timezone ID.

string

First name.

string

Last name.

string

Virtual extension.

string

Default language (e.g. en_US, es_ES, pt_BR).

string

Maximum session time.

string

Maximum concurrent sessions.

string

Two-factor authentication type (default, disabled, email, google).

string

Member of all skill groups (1/0).

string

Member of all desks (1/0).

string

PBX region (0 - default).

desks
array of integers

IDs of desks associated with the user.

desks
roles
array of integers

IDs of roles assigned to the user.

roles
skill_groups
array of integers

IDs of skill groups assigned to the user.

skill_groups
Responses

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