Creates a new user (end-user or agent).
Input Fields
- User
- Name (text): The name of the user
- External ID (text): An ID that you can assign to match this user with your own records
- Alias (text): The user’s alias which is displayed to end-users
- Verified? (true/false): If the user’s identity has been verified.
- Locale ID (number): The ID of the user’s language
- Timezone (text): The user’s timezone using tz database names
- Email (text): The user’s primary email address
- Phone (text): The user’s primary phone number
- Details (text): Any details about the user
- Notes (text): Any notes about the user
- Organization ID (number): The ID of the organization that the user is associated with
- Role (text): The role of the user. Can be “agent”, “end-user”, or “admin”.
- Custom role ID (number): The ID of a custom role if the user is an agent on an enterprise plan
- Moderator? (true/flase): If the user is a forum moderator
- Ticket Restriction (text): Specifies which ticket types the user has access to. Can be ”organization”, “groups”, “assigned”, “requested”, or “null”.
- Private Comments Only? (true/false): If the user can only create private comments
- Restricted Agent? (true/false): If the agent has any restrictions
- Custom Fields
- A dynamically generated list of any custom fields associated with the account’s users
Output Fields
- Output
- User ID (number): The ID of the newly created user