Skip to content

Update a user

Update a user with the provided details.

PATCH /integrations/user/

Headers

NameValue
AuthorizationBearer Access Token
Content-Typeapplication/json

Query Parameters

NameTypeRequiredDescription
emailstringYesEmail of the user

Payload

number
string

Phone number of user to be created (E.164 format)

roles
array of integer

Updated list of role ids of user. This will replace the older roles assigned to the user

first_name
string

First name of the user

last_name
string

Last name of the user

is_active
boolean

To activate or deactivate the user. On deactivating a user, all licenses are unassigned too. On activating, Viewer license is assigned by default

license
string

One of Plan or Viewer. In trial accounts, Plan license will be assigned by default

assigned_addon_licenses
array of string

List of addon licenses to assign to the user. Possible values are: AUTODIAL, BROWSER CALLING (For INR accounts only), WHATSAPP BUSINESS

unassigned_addon_licenses
array of string

List of addon licenses to unassign from the user. Possible values are: AUTODIAL, BROWSER CALLING (For INR accounts only), WHATSAPP BUSINESS

browser_calls
boolean

To enable or disable Browser Based calling for the user (without removing the licenses assigned to the user). Ignored and set to True if BROWSER CALLING license is assigned via the same API request.

status
string

One of ONLINE or AWAY. If set to AWAY, the user will not receive any calls

Response

{
"success": true,
"message": "string",
"data": {
"user_id": "string",
"first_name": "string",
"last_name": "string",
"email": "email",
"is_active": true,
"number": {
"id": 0,
"country_code": "string",
"phone_number": "string",
"loc": "string",
"created_at": "date-time"
},
"roles": [],
"browser_calls": true,
"license": "string",
"addon_licenses": [
"string"
],
"status": "string"
}
}