PUT /api/v2/users/{user_id}
Update UserServers
- https://{subdomain}.{domain}.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id |
Integer | Yes |
The id of the user |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
user |
Object | Yes |
Input schema for updating a user. All fields are optional - only include the fields you want to update. |
user.external_id |
String | No |
A unique identifier from another system |
user.alias |
String | No |
An alias displayed to end users |
user.organization_id |
Integer | No |
The id of the user's organization |
user.signature |
String | No |
The user's signature. Only agents and admins can have signatures |
user.email |
String | No |
The user's primary email address |
user.default_group_id |
Integer | No |
The id of the user's default group |
user.locale |
String | No |
The user's locale. A BCP-47 compliant tag for the locale. If both "locale" and "locale_id" are present on create or update, "locale_id" is ignored and only "locale" is used. |
user.custom_role_id |
Integer | No |
A custom role if the user is an agent on the Enterprise plan or above |
user.user_fields |
Object | No |
Values of custom fields in the user's profile |
user.only_private_comments |
Boolean | No |
true if the user can only create private comments |
user.verified |
Boolean | No |
Any of the user's identities is verified |
user.identities[] |
Array | No | |
user.identities[].verification_method |
String | No |
Indicates the state of user identity verification. Valid values:
|
user.identities[].type |
String | Yes |
Valid values:
|
user.identities[].primary |
Boolean | No |
If the identity is the primary identity. Writable only when creating, not when updating. |
user.identities[].value |
String | Yes | |
user.identities[].verified |
Boolean | No |
If the identity has been verified. Deprecated. Use |
user.role |
String | No |
The user's role |
user.language |
String | No |
The user's language preference. Alias for locale. |
user.organization_ids[] |
Array | No |
The ids of the user's organizations |
user.time_zone |
String | No |
The user's time zone |
user.agent_brand_ids[] |
Array | No |
The IDs of the brands the agent is assigned to |
user.locale_id |
Integer | No |
The user's language identifier |
user.suspended |
Boolean | No |
If the user is suspended |
user.remote_photo_url |
String | No |
A URL pointing to the user's profile picture |
user.ticket_restriction |
String | No |
Specifies which tickets the user has access to |
user.details |
String | No |
Any details you want to store about the user, such as an address |
user.name |
String | No |
The user's name |
user.notes |
String | No |
Any notes you want to store about the user |
user.moderator |
Boolean | No |
Designates whether the user has forum moderation capabilities |
user.phone |
String | No |
The user's primary phone number |
user.tags[] |
Array | No |
The user's tags |
user.shared_phone_number |
Boolean | No |
Whether the phone number is shared or not |
user.photo |
Object | No |
The user's profile picture |
user.skip_verify_email |
Boolean | No |
If true, the user won't receive a verification email |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.