Articles

Organizations

Permission Groups

Sections

Ticket Comments

POST requests only. Users to add as cc's when creating a ticket. See Setting Collaborators

Tickets

User Segments

Whether or not the user is a chat-only agent

A custom role if the user is an agent on the Enterprise plan or above

Any details you want to store about the user, such as an address

The user's primary email address. *Writeable on create only. On update, a secondary email is added. See Email Address

A unique identifier from another system. The API treats the id as case insensitive. Example: "ian1" and "IAN1" are the same value.

Automatically assigned when the user is created

Last time the user signed in to Zendesk Support or made an API request using an API token or basic authentication

Designates whether the user has forum moderation capabilities

Any notes you want to store about the user

true if the user can only create private comments

The id of the user's organization. If the user has more than one organization memberships, the id of the user's default organization. If updating, see Organization ID

The user's primary phone number. See Phone Number below

The user's profile picture represented as an Attachment object

A URL pointing to the user's profile picture.

This parameter is inert and has no effect. It may be deprecated in the future. Previously, this parameter determined whether a user could access a CSV report in a legacy Guide dashboard. This dashboard has been removed. See Announcing Guide legacy reporting upgrade to Explore

If the agent has any restrictions; false for admins and unrestricted agents, true for other agents

The user's role. Possible values are "end-user", "agent", or "admin"

The user's role id. 0 for a custom agent, 1 for a light agent, 2 for a chat agent, 3 for a chat agent added to the Support account as a contributor (Chat Phase 4), 4 for an admin, and 5 for a billing admin

If the user is shared from a different Zendesk Support instance. Ticket sharing accounts only

If the user is a shared agent from a different Zendesk Support instance. Ticket sharing accounts only

Whether the phone number is shared or not. See Phone Number below

The user's signature. Only agents and admins can have signatures

If the agent is suspended. Tickets from suspended users are also suspended, and these users cannot sign in to the end user portal

Specifies which tickets the user has access to. Possible values are: "organization", "groups", "assigned", "requested", null. "groups" and "assigned" are valid only for agents. If you pass an invalid value to an end user (for example, "groups"), they will be assigned to "requested", regardless of their previous access

Zendesk API Integration Profile

Get better integration infrastructure for your SaaS product today.