Update User
Update existing user.
Input
| Field | Definition | Type | Required |
|---|---|---|---|
|
Update by |
|||
|
User ID |
Unique identifier of the user.
The ID is in the URL: http://<your domain>.zendesk.com/agent/users/< User ID >. |
Number | TRUE |
|
User |
|||
|
Name |
Name of the user. | Text | FALSE |
|
External ID |
Unique external ID of the user. | Text | FALSE |
|
Alias |
An alias displayed to end users. |
Text | FALSE |
|
Verified? |
Indicates whether the user's identity has been verified. |
True/False | FALSE |
|
Locale ID |
User's language identifier. |
Number | FALSE |
|
Locale |
User's locale; this is a BCP-47 compliant tag. |
Text | FALSE |
|
Timezone |
User's time zone. See Time Zone. |
Text | FALSE |
|
|
User's primary email address. |
Text | FALSE |
|
Phone |
User's primary phone number. |
Text | FALSE |
|
Details |
Additional miscellaneous details about the user, such as an address. |
Text | FALSE |
|
Notes |
Notes about the user. |
Text | FALSE |
|
Organization ID |
Identification code of organization with which user is associated. |
Number | FALSE |
|
Role |
User's role; possible values are end-user, agent, or admin. |
Dropdown | FALSE |
|
Default Group ID |
ID of the user's default group. |
Number | FALSE |
|
Signature |
User's signature; only agents and admins have a signature. |
Text | FALSE |
|
Custom Role ID |
A custom role if the user is an agent on the Enterprise plan. |
Number | FALSE |
|
Moderator? |
Designates whether the user has forum moderation capabilities. |
True/False | FALSE |
|
Ticket Restriction |
Specifies which tickets the user has access to; possible values are organization, groups, assigned, requested, null. |
Dropdown | FALSE |
|
Private Comments Only? |
Indicates whether a user can create private comments; true if the user can only create private comments. |
True/False | FALSE |
|
Restricted Agent? |
Indicates whether the agent has any restrictions; false for admins and unrestricted agents, true for other agents. |
True/False | FALSE |
|
Tags |
User's tags; only present is your account has user tagging available. |
List | FALSE |
|
Custom Fields |
Dynamically generated list of any custom fields associated with users. More on custom Fields. |
Various |
FALSE |
Output
| Field | Definition | Type |
|---|---|---|
|
User |
||
|
User ID |
Unique identifier of the user. | Number |
|
User URL |
A URL to the user. |
Text |
|
Name |
Name of the user. | Text |
|
|
User's primary email address. |
Text |
|
Created At |
Date and time when the object was created. | Date & Time |
|
Updated At |
Time and date the user was updated. |
Date & Time |
|
Timezone |
User's time zone. See Time Zone. |
Text |
|
IANA Timezone |
IANA time zone of the user. |
Text |
|
Phone |
User's phone number. |
Text |
|
Shared Phone Number |
If true, the phone number is shared. |
True/False |
|
Locale ID |
User's language identifier. |
Number |
|
Locale |
User's locale; this is a BCP-47 compliant tag. |
Text |
|
Organization ID |
Identification code of organization with which user is associated. |
Number |
|
Role |
User's role; possible values are end-user, agent, or admin. |
Text |
|
Verified? |
If true, user is verified. |
True/False |
|
External ID |
Unique external ID of the user. | Text |
|
Tags |
User's tags; only present is your account has user tagging available. |
Text |
|
Alias |
User's alias. |
Text |
|
Active? |
If false, the user was deleted. |
True/False |
|
Shared? |
If true, user is shared. |
True/False |
|
Shared Agent? |
If true, user is a shared agent from another support instance. |
True/False |
|
Last Login At |
Last time the user signed in. |
Date & Time |
|
Two Factor Auth Enabled |
If true, two factor authentication is enabled. |
True/False |
|
Signature |
User's signature; only agents and admins have a signature. |
Text |
|
Details |
Additional miscellaneous details about the user, such as an address. |
Text |
|
Notes |
Notes about the user. |
Text |
|
Role Type |
User's role type. |
Number |
|
Custom Role ID |
User's custom role. |
Text |
|
Moderator? |
If true, the user has forum moderation capabilities. |
True/False |
|
Ticket Restriction |
Specifies which tickets to which the user has access. |
Text |
|
Private Comments Only? |
If true, the user can only create private comments. |
True/False |
|
Restricted Agent? |
If true, the agent has restrictions. |
True/False |
|
Suspended? |
If true, the agent is suspended. |
True/False |
|
Chat Only? |
If true, the user is a chat-only agent. |
True/False |
|
Default Group ID |
User's default group ID. |
Number |
|
Report CSV? |
If true, the user can access the CSV report. |
True/False |
|
Custom Fields |
Dynamically generated list of any custom fields associated with users. More on custom Fields. |
Various |