Go to app
Academy
What's new?
Tray UAC
Developer
Connectors
Templates
Help Center
Back
Zendesk
Overview
Operations (sample payloads)
Operations
Zendesk Operations
Latest version:
8.0
Changelog
Add comment to ticket
Add a comment to a ticket.
Count organization members
Count the number of members of an organization.
Create automation
Create an automation.
Create brand
Create a brand.
Create group
Create a group.
Create group membership
Create a group membership entry. This links an agent to a group.
Create group memberships (bulk)
Create one or more group membership entries. This links agents to groups. Assigns a maximum of 100 agents to given groups.
Create jira link
Create a link to connect between a Jira issue and a Zendesk ticket.
Create macro
Create a macro (one or more actions that modify the values of a ticket's fields).
Create or update organization
Create or update an organization.
Create organization
Create a new organization.
Create organization field
Create an organization field.
Create schedule
Create a support schedule.
Create sla policy
Create a service level agreement policy.
Create target
Create an external target to send notifications to with triggers and automations.
Create ticket
Create a new ticket.
Create ticket field
Create a ticket field.
Create ticket form
Create a ticket form.
Create trigger
Create a trigger (one or more actions performed when a ticket is created or updated).
Create user
Create a new user.
Create user field
Create a custom user field.
Create user identity
Create an identity for a user.
Create view
Create a view.
Create/update user
Create a new user if the user does not already exist or update an existing user identified by e-mail address or external ID. To create a new user, please provide a name. To update an existing user, please provide either an email address or external ID
Delete group membership
Removes an agent from a group
Delete group memberships (bulk)
Removes an agent from a group.
Delete jira link
Delete a link between a Jira issue and a Zendesk ticket.
Delete ticket
Delete a ticket.
Delete ticket form
Delete a ticket form.
Delete ticket tags
Delete tags from a ticket.
Delete user field
Delete a custom user field.
Delete user identity
Delete a specified user identity.
Filter articles
Filter articles by specified fields.
Get article
Retrieve a specific article.
Get article attachment
Retrieve a specific article attachment.
Get article comment
Retrieve a specific article comment from knowledge base.
Get group membership
Retrieve a group membership.
Get label
Retrieve a specific label.
Get organization
Get information about an organization.
Get organization custom field
Retrieve an organization custom field.
Get settings
Retrieve the settings that are available for the account.
Get ticket
Get information about a specific ticket.
Get ticket audit
Get information about a specific ticket audit.
Get ticket form
Get information about a specific ticket form.
Get user
Retrieve a specified user.
Import ticket
Imports a ticket to Zendesk from a legacy system. Unlike 'Create ticket', this operation allows you to set system parameters like 'created_at', 'updated_at', and 'solved_at'.
List agents DDL
List article attachments
List all attachments in a specific article.
List article attachments DDL
List article comments
List the comments created by a specific user, or all comments made by all users on a specific article.
List article comments DDL
List article labels
Retrieve all labels given to a specific article.
List article translations
Retrieve translations for a specific article.
List articles
Retrieve list of all articles.
List articles DDL
List assignable group memberships
List the assignable group memberships.
List audits for a ticket
List the audits linked to a specific ticket.
List audits for a ticket DDL
List brands
Retrieve a list of all brands for your account sorted by name.
List categories
List all categories in knowledge base.
List categories DDL
List custom user roles
Retrieve a list of custom user roles.
List custom user roles DDL
List group memberships
List the group memberships e.g. list the agents and the groups that they are assigned to.
List groups
Get a list of all of the groups in your Zendesk account.
List groups DDL
List labels
List all labels in knowledge base that can be applied to articles.
List labels DDL
List locales
Retrieve a list of locales available to the account.
List locales DDL
List organization fields
Get a list of all of the available organization fields in your Zendesk account.
List organization fields ID DDL
List organization fields key DDL
List organization memberships
Get a list of all of the memberships (users) attached to this organization.
List organizations
Get a list of all of the organizations in your Zendesk account, grouped into pages.
List organizations DDL
List sections
List sections.
List sections DDL
List ticket active custom fields DDL
List ticket active fields DDL
List ticket comments
List the comments (both public and private) linked to a specific ticket.
List ticket fields
Get a list of all the ticket fields.
List ticket forms
List of all ticket forms for your account if accessed as an admin or agent.
List ticket forms DDL
List ticket tags
List the tags linked to a specific ticket.
List ticket tags DDL
List tickets
Get a list of all the tickets.
List tickets for organization
Get a list of all the tickets for an organization.
List tickets for user
Get a list of all the tickets for a user.
List translations
List all translations for a given article, section, or category.
List triggers
Retrieve a list of triggers for the current account.
List user fields
Retrieve a list of user fields.
List user fields DDL
List user fields keys DDL
List user identities
Get a list of all of a user's identities, including emails and phone numbers.
List user identities DDL
List users
Retrieve a list of users.
List users DDL
Make user identity primary
Make one of a user's identities the primary identity.
Raw HTTP request (advanced)
Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication.
Search
Search for tickets, users, and organizations by query parameter.
Search organization by name
Search for organizations using the name of the organization.
Search organizations by External ID.
Search for organizations using the value of an "External ID" field previously set.
Search users
Search for users by query string.
Search users by ID
Search for users by ID or external ID.
Update organization
Update an organization.
Update organization field
Update an organization field using a specified organization ID.
Update ticket
Update information about a ticket.
Update ticket form
Update an existing ticket form.
Update trigger
Update a trigger.
Update user
Update an existing user.
Update user field
Update information about a user field.
Upload attachment
Upload a file attachment to Zendesk. A token will be returned, allowing you to attach files to tickets.
Previous
Operations (sample payloads)
