Supported attributes reference

The following table consists of the attributes that can be mapped on a user during provisioning.

Attribute Description

email

The primary email address of the user.

An update to the email attribute will make the new email as primary and leave the old email as secondary.

external_id

A unique id you can set on a user.

name

The name of the user

alias

An Agent’s alias that is displayed visible by end-user type users.

custom_role_id

The if of the custom role for the user. The id of a custom role can be obtained from Zendesk after creating it.

details

Any details you wish to store about the user.

locale_id

The id of the user’s locale. The id of a locale can be obtained from Zendesk.

moderator

Designates whether the user has forum moderation capabilities. Acceptable options include: “true” or “false”.

notes

A general note field for the user.

only_private_comments

Designates whether the user can only create private comments. Acceptable options include: “true” or “false”.

organization_id

The id of the organization this user is associated with. The id of an organization can be obtained from Zendesk after creating it.

Example: An organization called “Employee” may have an id that looks like “187178237”.

phone

The primary phone number of a user.

role

The role of the user in Zendesk. Acceptable options include: “end-user”, “agent” and “admin”.

signature

The user’s signature. Only available for agents and admins.

tags

A multi value attribute representing all the user’s tags. Tags will only be present if your account has user tagging enabled.

ticket_restriction

Specifies which tickets the user has access to. Possible values are: “organization”, “groups”, “assigned”, “requested”, null.

time_zone

The user’s time zone.

verified

Designates if the user’s identity has been verified. Acceptable options include: “true” or “false”.