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": "John" }

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

User ID.

string
required

PBX Name (subdomain)

Body Params

Username.

Email address.

New password for the user account.

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

Whether the user is active (1/0).

SIP URI.

Auto-dial status (1/0).

Whether the user is deleted (1/0).

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

Timezone ID.

First name.

Last name.

Virtual extension.

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

Maximum session time.

Maximum concurrent sessions.

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

Member of all desks (1/0).

PBX region (0 - default).

array | null

IDs of desks associated with the user.

array | null

IDs of roles assigned to the user.

Responses

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