Update User

Updates the specified user and returns the updated record.

When to use. Change one or more fields on an existing user. Only the fields you include in the request body are changed; omitted fields keep their current values.

Parameters. id (path, required): the ID of the user to update.

Notes. Send only the fields you want to change. Passing password sets a new password. You can reassign roles and desks by passing their IDs. See the request schema for the full list of accepted fields.

Returns. 200 OK with { "users": [ { ... } ] }.

Example. PUT /api/users/5 with body { "first_name": "Jane" }

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

User ID.

Body Params

Request body for updating a user. All fields are optional; only supplied fields are changed.

string

Username.

string

Email address.

string

New password for the user account.

integer

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.

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