Create User
Create a new user.
Input
Field | Definition | Type | Required |
---|---|---|---|
User | |||
Name |
Name of the user. |
String | TRUE |
External ID |
Unique external ID of the user. |
String | FALSE |
Alias | Alias displayed to end users. | String | FALSE |
Verified? | Indicates whether the user's identity has been verified. | Boolean | FALSE |
Locale ID | Language identifier of the user. | Number | FALSE |
Locale | Locale of the user. This is a BCP-47 compliant tag. | String | FALSE |
Timezone | Time zone of the user. See Time Zone. | String | FALSE |
Primary email address of the user. | String | FALSE | |
Phone | Primary phone number of the user. | String | FALSE |
Details |
Details you want to store about the user.
For example, address. |
String | FALSE |
Notes | Notes you want to store about the user. | String | FALSE |
Organization ID | Identification code of organization with which the user is associated. | Number | FALSE |
Role | Role of the user. Possible values are end-user , agent , or admin . |
Dropdown | FALSE |
Default Group ID | Unique ID of the user's default group. | Number | FALSE |
Signature | Signature of the user. Only agents and admins have a signature. | String | FALSE |
Custom Role ID | Custom role if the user is an agent on the Enterprise plan. | Number | FALSE |
Moderator? | Designates whether the user has forum moderation capabilities. | Boolean | FALSE |
Ticket Restriction | Specifies which tickets the user has access to. Possible values are: organization , groups , assigned , requested , null . |
Dropdown | FALSE |
Private Comments Only? | true if the user can only create private comments. |
Boolean | FALSE |
Restricted Agent? | If the agent has any restrictions; false for admins and unrestricted agents, true for other agents. | Boolean | FALSE |
Tags | Tags of the user. Only present if your account has user tagging available. | String | FALSE |
Custom Fields | A dynamically generated list of any custom fields associated with users. See About custom field types. | Various | FALSE |
Output
Field | Definition | Type |
---|---|---|
User ID | Unique identifier of the user. | String |
User URL | URL to the user. | String |
Name |
Name of the user. |
String |
Primary email address of the user. | String | |
Created At |
Date and time when the object was created. |
Date & Time |
Updated At | Time and date the user was updated. | Date & Time |
Timezone | Time zone of the user. See Time Zone. | String |
IANA Timezone | IANA time zone of the user. | String |
Phone | Phone number of the user. | String |
Shared Phone Number | Indicates whether the phone number is shared. | Boolean |
Locale ID | Language identifier of the user. | Number |
Locale | Locale of the user. This is a BCP-47 compliant tag. | String |
Organization ID | Identification code of organization with which the user is associated. | Number |
Role | Role of the user. Possible values are end-user , agent , or admin . |
String |
Verified? | Indicates whether the user is verified. | Boolean |
External ID | Unique identifier from another system. | String |
Tags | Tags of the user. Only present if your account has user tagging available. | String |
Alias | Alias of the user. | String |
Active? | If false, user has been deleted. | Boolean |
Shared? | If true, user is shared. | Boolean |
Shared Agent? | If true, user is a shared agent from another support instance. | Boolean |
Last Login At | Last time the user signed in. | String |
Two Factor Auth Enabled? | If true, two factor authentication is enabled. | Boolean |
Signature | Signature of the user. Only agents and admins have a signature. | String |
Details | Details that you want to store about the user, such as an address. | String |
Notes | Notes that you want to store about the user. | String |
Role Type | Role type of the user. | Number |
Custom Role ID | Custom role of the user. | String |
Moderator? | If true, the user has forum moderation capabilities. | Boolean |
Ticket Restriction | Specifies which tickets to which the user has access. | String |
Private Comments Only? | If true, the user can only create private comments. | Boolean |
Restricted Agent? | If true, the agent has restrictions. | Boolean |
Suspended? | If true, the agent is suspended. | Boolean |
Chat Only? | If true, the user is a chat-only agent. | Boolean |
Default Group ID | Unique ID of the user's default group. | Number |
Report CSV? | If true, the user can access the CSV report. | Boolean |
Custom Fields | A dynamically generated list of any custom fields associated with users. See About custom field types. | Various |