Connectors
Customer Support & Success
Zendesk
Customer support: tickets, users, organizations, macros, and satisfaction ratings
- Signs in with
- Connection fields
- Runs on
- Cloud or On-Prem Worker
- Operations
- 626
- Ready-made triggers
- 0
Connect Zendesk
- In Neblex open Connect › Connections and click New Connection.
- Search for Zendesk and give the connection a clear name.
- Fill in the fields. Secret values are encrypted and never shown again.
- Click Test, then Create Connection.
| Field | What to enter |
|---|---|
| Zendesk subdomainRequired | The part before .zendesk.com.Example: example |
| OAuth 2.0 access tokenOptionalSecret | Recommended OAuth credential. |
| Username or email/tokenOptional | Username for the documented HTTP Basic alternative. |
| Password or API tokenOptionalSecret | Password or API token for the HTTP Basic alternative. |
Use it in a flow
- Open a flow, open the node library and search for Zendesk.
- Drag it onto the canvas and choose an Operation and your connection.
- Map the operation's fields from earlier steps, or click Map with Matt.
- Use Test this step to see what it returns, then save.
To start a flow from Zendesk without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Zendesk can send webhooks, a Webhook trigger receives them at its own URL.
Operations
626 operations in 89 groups. Each one is a step you can add to a flow.
Account Setting4
Show Email SettingsGetAccountEmailSettings | GET | Returns the email settings for the account. |
Show SettingsShowAccountSettings | GET | Shows the settings that are available for the account. |
Update Account SettingsUpdateAccountSettings | PUT | Updates settings for the account. |
Update Email SettingsUpdateAccountEmailSettings | PUT | Updates email settings for the account. |
Activity Stream3
Count ActivitiesCountActivities | GET | Returns an approximate count of ticket activities in the last 30 days affecting the agent making the request. |
List ActivitiesListActivities | GET | Lists ticket activities in the last 30 days affecting the agent making the request. |
Show ActivityShowActivity | GET | Lists a specific activity. |
Approval Request2
Create Approval RequestCreateApprovalRequest | POST | Creates an approval request for a ticket. |
List Approval RequestsListApprovalRequests | GET | Lists all approval requests for the current account with optional filtering by status and assignee. |
Attachment6
Delete AttachmentDeleteAttachment | DELETE | Deletes the attachment. |
Delete UploadDeleteUpload | DELETE | |
Redact Comment AttachmentRedactCommentAttachment | PUT | Redaction allows you to permanently remove attachments from an existing comment on a ticket. |
Show AttachmentShowAttachment | GET | Shows attachment details. |
Update Attachment for MalwareUpdateAttachment | PUT | Toggles enabling or restricting agent access to attachments with detected malware. |
Upload FilesUploadFiles | POST | Uploads a file that can be attached to a ticket comment. |
Audit Log3
Export Audit LogsExportAuditLogs | POST | |
List Audit LogsListAuditLogs | GET | |
Show Audit LogShowAuditLog | GET |
Automation9
Bulk Delete AutomationsBulkDeleteAutomations | DELETE | Deletes the automations corresponding to the provided comma-separated list of IDs. |
Create AutomationCreateAutomation | POST | Creates an automation. |
Delete AutomationDeleteAutomation | DELETE | Note : You might be restricted from deleting some default automations. |
List Active AutomationsListActiveAutomations | GET | Lists all active automations. |
List AutomationsListAutomations | GET | Lists all automations for the current account. |
Search AutomationsSearchAutomations | GET | Pagination |
Show AutomationShowAutomation | GET | |
Update AutomationUpdateAutomation | PUT | Updates an automation. |
Update Many AutomationsUpdateManyAutomations | PUT | Note : You might be restricted from updating some default automations. |
Basic4
Create Ticket or Voicemail TicketCreateTicketOrVoicemailTicket | POST | Allowed For Agents |
Create Ticket or Voicemail Ticket (form)CreateTicketOrVoicemailTicketForm | POST | Allowed For Agents |
Open a User's Profile in an Agent's BrowserOpenUsersProfileInAgentBrowser | POST | Allows you to instruct an agent's browser to open a user's profile. |
Open Ticket in Agent's BrowserOpenTicketInAgentBrowser | POST | Allows you to instruct an agent's browser to open a ticket. |
Bookmark3
Create BookmarkCreateBookmark | POST | Allowed For - Agents |
Delete BookmarkDeleteBookmark | DELETE | Allowed For - Agents (own bookmarks only) |
List BookmarksListBookmarks | GET | Archived tickets are not included in the response. |
Brand9
Check Host Mapping ValidityCheckHostMappingValidity | GET | Returns a JSON object determining whether a host mapping is valid for a given subdomain. |
Check Host Mapping Validity for an Existing BrandCheckHostMappingValidityForExistingBrand | GET | Returns a JSON object determining whether a host mapping is valid for the given brand. |
Create BrandCreateBrand | POST | Creates a brand. |
Delete a BrandDeleteBrand | DELETE | Deletes a brand. |
Delete a Brand LogoDeleteBrandLogo | DELETE | Removes the logo from a brand. |
List BrandsListBrands | GET | Returns a list of all brands for your account sorted by name. |
Show a BrandShowBrand | GET | Returns a brand for your account. |
Update a BrandUpdateBrand | PUT | Returns an updated brand. |
Update a Brand LogoUpdateBrandLogo | PUT | Sets or replaces the logo on a brand using a multipart file upload. |
Brand Agent6
Delete Brand Agent MembershipDeleteBrandAgentById | DELETE | Deletes a brand agent membership. |
List Agents By BrandListBrandAgentsByBrand | GET | Returns a list of all agents assigned to a specific brand. |
List Brand Agent MembershipsListBrandAgents | GET | Returns a list of all brand agent memberships for your account. |
List Brand Agent Memberships By UserListUserBrandAgents | GET | Returns a list of all brand agent memberships for a specific user. |
Show Brand Agent MembershipShowBrandAgentById | GET | Returns a brand agent membership for your account. |
Show Brand Agent Membership By UserShowUserBrandAgentById | GET | Returns a specific brand agent membership for a user. |
Channel Framework3
Push Content to SupportPushContentToSupport | POST | Pushes Channel framework content to Zendesk. |
Report Channelback Error to ZendeskReportChannelbackError | POST | |
Validate TokenValidateToken | POST |
Conversation Log1
List Conversation log for TicketListConversationLogForTicket | GET | Lists the conversation log events for a specified ticket. |
Country2
List Countries and Calling CodesListCountries | GET | Returns a list of all countries with their calling codes. |
Show CountryShowCountry | GET | Returns details for a specific country by ID. |
Custom Object6
Create Custom ObjectCreateCustomObject | POST | Creates an object describing all the properties required to create a custom object record Allowed For Admins |
Custom Objects LimitCustomObjectsLimit | GET | List the current count and the limit for custom objects Allowed For Admins |
Delete Custom ObjectDeleteCustomObject | DELETE | Permanently deletes the custom object with the specified key Allowed For Admins |
List Custom ObjectsListCustomObjects | GET | Lists all undeleted custom objects for the account Allowed For Agents |
Show Custom ObjectShowCustomObject | GET | Returns an object with the specified key Allowed For Agents |
Update Custom ObjectUpdateCustomObject | PATCH | Updates an individual custom object. |
Custom Object Field7
Create Custom Object FieldCreateCustomObjectField | POST | Creates any of the following custom field types: |
Custom Object Fields LimitCustomObjectFieldsLimit | GET | List the current count and the limit for a custom object's fields Allowed For Agents |
Delete Custom Object FieldDeleteCustomObjectField | DELETE | Deletes a field with the specified key. |
List Custom Object FieldsListCustomObjectFields | GET | Lists all undeleted custom fields for the specified object. |
Reorder Custom Fields of an ObjectReorderCustomObjectFields | PUT | Sets a preferred order of custom fields for a specific object by providing field ids in the desired order. |
Show Custom Object FieldShowCustomObjectField | GET | Returns a custom field for a specific object using a provided key or id of the field. |
Update Custom Object FieldUpdateCustomObjectField | PATCH | Updates individual custom object fields. |
Custom Object Permission9
Create Access RuleCreateAccessRule | POST | Creates a new access rule for a custom object. |
Delete Access RuleDeleteAccessRule | DELETE | Permanently deletes an access rule for a custom object. |
List Access Rule DefinitionsListAccessRuleDefinitions | GET | Returns the available field definitions and operators that can be used when creating access rules for a custom object. |
List Access RulesListAccessRules | GET | Returns a list of access rules for a custom object. |
List Permission PoliciesListPermissionPolicies | GET | Returns a list of permission policies for a custom object. |
Show Access RuleShowAccessRule | GET | Returns a specific access rule for a custom object. |
Show Permission PolicyShowPermissionPolicy | GET | Returns a permission policy for a specific role on a custom object. |
Update Access RuleUpdateAccessRule | PATCH | Updates an existing access rule for a custom object. |
Update Permission PolicyUpdatePermissionPolicy | PATCH | Updates a permission policy for a specific role on a custom object. |
Custom Object Record14
Autocomplete Custom Object Record SearchAutocompleteCustomObjectRecordSearch | GET | Retrieves an array of custom object records that have a field value that matches the value specified in the name parameter. |
Count Custom Object RecordsCountCustomObjectRecords | GET | Returns a total count of records for a specific custom object as well as the time the count was refreshed. |
Create Custom Object RecordCreateCustomObjectRecord | POST | Creates a custom object record according to all the properties described by a custom object definition. |
Create or Update Custom Object RecordUpsertCustomObjectRecordByExternalIdOrName | PATCH | Creates or updates a custom object record based on the provided external id or name. |
Custom Object Record Bulk JobsCustomObjectRecordBulkJobs | POST | Queues a background job to perform bulk actions on up to 100 custom object records per single request. |
Custom Object Records LimitCustomObjectRecordsLimit | GET | List the current count and the limit for custom object records Allowed For Agents |
Delete Custom Object RecordDeleteCustomObjectRecord | DELETE | Deletes a record with the specified id. |
Delete Custom Object Record by External Id Or NameDeleteCustomObjectRecordByExternalIdOrName | DELETE | Deletes a record with the specified external id or name. |
Filtered Search of Custom Object RecordsFilteredSearchCustomObjectRecords | POST | Returns an array of custom object records that meet the search and filter criteria. |
Incremental Custom Object Record Export, Cursor BasedIncrementalCustomObjectRecordExportCursor | GET | Returns the custom object records that changed since the start time. |
List Custom Object RecordsListCustomObjectRecords | GET | Lists all undeleted custom object records for the specified object. |
Search Custom Object RecordsSearchCustomObjectRecords | GET | Returns an array of custom object records where the search query matches the values in Text Fields, Multi Line Text fields, and RegExp fields. |
Show Custom Object RecordShowCustomObjectRecord | GET | Returns a custom record for a specific object using a provided id. |
Update Custom Object RecordUpdateCustomObjectRecord | PATCH | Updates an individual custom object record. |
Custom Object Record Attachment5
Create Custom Object Record AttachmentCreateCustomObjectRecordAttachment | POST | Creates a new attachment associated with a custom object record. |
Delete Custom Object Record AttachmentDeleteCustomObjectRecordAttachment | DELETE | Deletes the specified attachment associated with a custom object record. |
Download Custom Object Record AttachmentDownloadCustomObjectRecordAttachment | GET | Downloads the specified attachment content. |
List Custom Object Record AttachmentsListCustomObjectRecordAttachments | GET | Lists all attachments associated with a custom object record. |
Update Custom Object Record Attachment for MalwareUpdateCustomObjectRecordAttachment | PUT | Updates malware access settings for the specified attachment. |
Custom Role5
Create Custom RoleCreateCustomRole | POST | Availability |
Delete Custom RoleDeleteCustomRoleById | DELETE | Availability |
List Custom RolesListCustomRoles | GET | Availability |
Show Custom RoleShowCustomRoleById | GET | Availability |
Update Custom RoleUpdateCustomRoleById | PUT | Availability |
Custom Ticket Statuse7
Bulk Update Default Custom Ticket StatusBulkUpdateDefaultCustomStatus | PUT | Updates the default values for many custom ticket statuses at once. |
Create Custom Ticket StatusCreateCustomStatus | POST | Takes a custom status object that specifies the custom ticket status properties to create. |
Create Ticket Form Statuses for a Custom StatusCreateTicketFormStatusesForCustomStatus | POST | Creates one or many tickets form status associations for a custom status. |
Delete Custom Ticket StatusDeleteCustomStatus | DELETE | Deletes the custom ticket status. |
List Custom Ticket StatusesListCustomStatuses | GET | Lists all undeleted custom ticket statuses for the account. |
Show Custom Ticket StatusShowCustomStatus | GET | Returns the custom ticket status object. |
Update Custom Ticket StatusUpdateCustomStatus | PUT | Takes a custom status object that specifies the properties to update. |
Deletion Schedule5
Create Deletion ScheduleCreateDeletionSchedule | POST | Creates a new deletion schedule. |
Delete Deletion ScheduleDeleteDeletionSchedule | DELETE | Deletes a deletion schedule by its id. |
Get Deletion ScheduleGetDeletionSchedule | GET | Gets a deletion schedule by its id. |
List Deletion SchedulesListDeletionSchedules | GET | Lists all deletion schedules for the account. |
Update Deletion ScheduleUpdateDeletionSchedule | PUT | Updates a deletion schedule by its id. |
Dynamic Content6
Create ItemCreateDynamicContent | POST | Create a new content item, with one or more variants in the item's variants array. |
Delete ItemDeleteDynamicContentItem | DELETE | |
List ItemsListDynamicContents | GET | Returns a list of all dynamic content items for your account if accessed as an admin or agents who have permission to manage dynamic content. |
Show ItemShowDynamicContentItem | GET | |
Show Many ItemsShowManyDynamicContents | GET | Stability |
Update ItemUpdateDynamicContentItem | PUT | The only attribute you can change is the name. |
Dynamic Content Item Variant7
Create Many VariantsCreateManyDynamicContentVariants | POST | |
Create VariantCreateDynamicContentVariant | POST | You can only create one variant for each locale id. |
Delete VariantDeleteDynamicContentVariant | DELETE | |
List VariantsDynamicContentListVariants | GET | Returns all the variants of the specified dynamic content item. |
Show VariantShowDynamicContentVariant | GET | |
Update Many VariantsUpdateManyDynamicContentVariants | PUT | Updates one or more variants. |
Update VariantUpdateDynamicContentVariant | PUT | Updates the specified variant. |
Email Notification3
List Email NotificationsListEmailNotifications | GET | |
Show Email NotificationShowEmailNotification | GET | Shows details on an email notification. |
Show Many Email NotificationsShowManyEmailNotifications | GET | Shows details of many email notifications. |
Global Client3
List Global OAuth ClientsListGlobalOAuthClients | GET | Returns all the global OAuth clients that users on your account have authorized. |
Show Global OAuth ClientShowGlobalClient | GET | Returns the global OAuth client associated with the ID sent on the request. |
Show Token summary for Global OAuth ClientsGlobalOAuthClientsTokenSummary | GET | Returns information about tokens for the global clients that your account has authorized. |
Grant Type Token1
Create Token for Grant TypeCreateTokenForGrantType | POST | Returns an OAuth access token in exchange for one of the following: |
Group12
Autocomplete GroupsAutocompleteGroups | GET | Returns an array of groups whose name starts with the value specified in the name parameter. |
Count GroupsCountGroups | GET | Returns an approximate count of groups. |
Count User GroupsCountUserGroups | GET | Returns an approximate count of groups for the specified user. |
Create GroupCreateGroup | POST | |
Delete GroupDeleteGroup | DELETE | |
List Assignable GroupsListAssignableGroups | GET | Pagination |
List Available AgentsListAvailableAgents | GET | Returns a list of all agents available to be added to groups. |
List GroupsListGroups | GET | Pagination |
List User GroupsListUserGroups | GET | Returns a list of groups for the specified user. |
Show Default GroupShowDefaultGroup | GET | |
Show GroupShowGroupById | GET | |
Update GroupUpdateGroup | PUT |
Group Membership14
Bulk Create MembershipsGroupMembershipBulkCreate | POST | Assigns up to 100 agents to given groups. |
Bulk Delete MembershipsGroupMembershipBulkDelete | DELETE | Immediately removes users from groups and schedules a job to unassign all working tickets that are assigned to the given user and group combinations. |
Create Group Membership for UserCreateUserGroupMembership | POST | Assigns an agent to a given group. |
Create MembershipCreateGroupMembership | POST | Assigns an agent to a given group. |
Delete MembershipDeleteGroupMembership | DELETE | Immediately removes a user from a group and schedules a job to unassign all working tickets that are assigned to the given user and group combination. |
Delete User's Group MembershipDeleteUserGroupMembership | DELETE | Immediately removes a user from a group and schedules a job to unassign all working tickets that are assigned to the given user and group combination. |
List Assignable MembershipsListAssignableGroupMemberships | GET | Returns a maximum of 100 group memberships per page. |
List Assignable Memberships By GroupListAssignableGroupMembershipsByGroup | GET | Returns a list of assignable group memberships for a specific group. |
List Group Memberships by UserListUserGroupMemberships | GET | Pagination |
List MembershipsListGroupMemberships | GET | Pagination |
List Memberships By GroupListGroupMembershipsByGroup | GET | Returns a list of all group memberships for a specific group. |
Set Membership as DefaultGroupMembershipSetDefault | PUT | Allowed For: |
Show MembershipShowGroupMembershipById | GET | The 'id' is the group membership id, not a group id. |
Show User's Group MembershipShowUserGroupMembershipById | GET | Returns a specific group membership for a user. |
Group SLA Policy7
Create Group SLA PolicyCreateGroupSLAPolicy | POST | |
Delete Group SLA PolicyDeleteGroupSLAPolicy | DELETE | |
List Group SLA PoliciesListGroupSLAPolicies | GET | |
Reorder Group SLA PoliciesReorderGroupSLAPolicies | PUT | |
Retrieve Supported Filter Definition ItemsRetrieveGroupSLAPolicyFilterDefinitionItems | GET | |
Show Group SLA PolicyShowGroupSLAPolicy | GET | |
Update Group SLA PolicyUpdateGroupSLAPolicy | PUT | Updates the specified policy. |
Incremental Export7
Incremental Organization ExportIncrementalOrganizationExport | GET | |
Incremental Sample ExportIncrementalSampleExport | GET | Use this endpoint to test the incremental export format. |
Incremental Ticket Event ExportIncrementalTicketEvents | GET | Returns a stream of changes that occurred on tickets, excluding events occuring within one minute of the request. |
Incremental Ticket Export, Cursor BasedIncrementalTicketExportCursor | GET | Returns the tickets that changed since the start time. |
Incremental Ticket Export, Time BasedIncrementalTicketExportTime | GET | Returns the tickets that changed since the start time. |
Incremental User Export, Cursor BasedIncrementalUserExportCursor | GET | |
Incremental User Export, Time BasedIncrementalUserExportTime | GET |
Incremental Skill Based Routing3
Incremental Attributes ExportIncrementalSkilBasedRoutingAttributesExport | GET | Returns a stream of changes that occurred on routing attributes. |
Incremental Attributes Values ExportIncrementalSkilBasedRoutingAttributeValuesExport | GET | Returns a stream of changes that occurred on routing attribute values. |
Incremental Instance Values ExportIncrementalSkilBasedRoutingInstanceValuesExport | GET | Returns a stream of changes that occurred on routing instance values. |
ITAM Asset8
Asset Bulk JobsItamAssetBulkJobs | POST | Queues a background job to perform bulk actions on up to 100 asset records per request. |
Create AssetCreateItamAsset | POST | Creates an asset. |
Delete AssetDeleteItamAsset | DELETE | Deletes an asset with the specified id. |
Filtered Search of AssetsFilteredSearchItamAssets | POST | Returns an array of assets that meet the complex search and filter criteria. |
List AssetsListItamAssets | GET | Lists all assets for all asset types. |
Search AssetsSearchItamAssets | GET | Returns an array of assets with values in text-based fields that match the search query. |
Show AssetShowItamAsset | GET | Returns the asset with the specified id. |
Update AssetUpdateItamAsset | PATCH | Updates an individual asset. |
ITAM Asset Field5
Create Asset FieldCreateItamAssetTypeField | POST | Creates an asset field for an individual asset type. |
Delete Asset FieldDeleteItamAssetTypeField | DELETE | Deletes an asset field with the specified id. |
List Asset FieldsListItamAssetTypeFields | GET | Lists all standard and custom fields for an asset type. |
Show Asset FieldShowItamAssetTypeField | GET | Returns an asset field with the specified id. |
Update Asset FieldUpdateItamAssetTypeField | PATCH | Updates an existing asset field with the specified id. |
ITAM Asset Location5
Create Asset LocationCreateItamLocation | POST | Creates a location. |
Delete Asset LocationDeleteItamLocation | DELETE | Deletes a location with the specified id. |
List Asset LocationsListItamLocations | GET | Lists all locations. |
Show Asset LocationShowItamLocation | GET | Returns the location with the specified id. |
Update Asset LocationUpdateItamLocation | PATCH | Updates an existing location. |
ITAM Asset Statuse5
Create Asset StatusCreateItamStatus | POST | Creates a status. |
Delete Asset StatusDeleteItamStatus | DELETE | Deletes a status with the specified id. |
List Asset StatusesListItamStatuses | GET | Lists all statuses. |
Show Asset StatusShowItamStatus | GET | Returns the status with the specified id. |
Update Asset StatusUpdateItamStatus | PATCH | Updates an existing status. |
ITAM Asset Type5
Create Asset TypeCreateItamAssetType | POST | Creates an asset type. |
Delete Asset TypeDeleteItamAssetType | DELETE | Deletes an asset type with the specified id. |
List Asset TypesListItamAssetTypes | GET | Lists all asset types. |
Show Asset TypeShowItamAssetType | GET | Returns an asset type with the specified id. |
Update Asset TypeUpdateItamAssetType | PATCH | Updates an existing asset type. |
Job Statuse3
List Job StatusesListJobStatuses | GET | Shows the statuses for background jobs. |
Show Job StatusShowJobStatus | GET | Shows the status of a background job. |
Show Many Job StatusesShowManyJobStatuses | GET | Accepts a comma-separated list of job status ids. |
Locale6
Detect Best Language for UserDetectBestLocale | GET | |
List Available Public LocalesListAvailablePublicLocales | GET | Lists the translation locales that are available to all accounts. |
List LocalesListLocales | GET | Lists the translation locales available for the account. |
List Locales for AgentListLocalesForAgent | GET | Lists the translation locales that have been localized for agents on a specific account. |
Show Current LocaleShowCurrentLocale | GET | This works like Show Locale, but instead of taking a locale id as an argument, it renders the locale of the user performing the request. |
Show LocaleShowLocaleById | GET |
Lookup Relationship2
Filter DefinitionsGetRelationshipFilterDefinitions | GET | Returns filter definitions based on the given target type. |
Get sources by targetGetSourcesByTarget | GET | Returns a list of source objects whose values are populated with the id of a related target object. |
Macro19
Bulk Delete MacrosDeleteManyMacros | DELETE | Deletes the macros corresponding to the provided comma-separated list of IDs. |
Create MacroCreateMacro | POST | Allowed For Agents |
Create Macro AttachmentCreateAssociatedMacroAttachment | POST | Allows an attachment to be uploaded and associated with a macro at the same time. |
Create Unassociated Macro AttachmentCreateMacroAttachment | POST | Allows an attachment to be uploaded that can be associated with a macro at a later time. |
Delete MacroDeleteMacro | DELETE | Allowed For Agents, with restrictions applying on certain actions |
List Active MacrosListActiveMacros | GET | Lists all active shared and personal macros available to the current user. |
List Macro Action DefinitionsListMacroActionDefinitions | GET | Returns the definitions of the actions a macro can perform. |
List Macro AttachmentsListMacroAttachments | GET | Lists the attachments associated with a macro. |
List Macro CategoriesListMacroCategories | GET | Lists all macro categories available to the current user. |
List MacrosListMacros | GET | Lists all shared and personal macros available to the current user. |
List Supported Actions for MacrosListMacrosActions | GET | Allowed For Agents |
Search MacrosSearchMacro | GET | Pagination |
Show Changes to TicketShowChangesToTicket | GET | Returns the changes the macro would make to a ticket. |
Show MacroShowMacro | GET | Allowed For Agents |
Show Macro AttachmentShowMacroAttachment | GET | Shows the properties of the specified macro attachment. |
Show Macro ReplicaShowDerivedMacro | GET | Returns an unpersisted macro representation derived from a ticket or macro. |
Show Ticket After ChangesShowTicketAfterChanges | GET | Returns the full ticket object as it would be after applying the macro to the ticket. |
Update MacroUpdateMacro | PUT | Allowed For Agents |
Update Many MacrosUpdateManyMacros | PUT | Updates the provided macros with the specified changes. |
OAuth Client7
Create ClientCreateOAuthClient | POST | |
Delete ClientDeleteClient | DELETE | Allowed for Admins |
Generate SecretClientGenerateSecret | PUT | Allowed for Admins |
List ClientsListOAuthClients | GET | Pagination |
List Current User's ClientsListCurrentUserOAuthClients | GET | Returns the OAuth clients owned by the current user. |
Show ClientShowClient | GET | Allowed for Admins |
Update ClientUpdateClient | PUT | Allowed for Admins |
OAuth Token6
Create TokenCreateOAuthToken | POST | Creates an OAuth access token directly using admin credentials, without going through an OAuth authorization flow. |
List TokensListOAuthTokens | GET | Returns the properties of the tokens for the current user. |
Revoke Current TokenRevokeCurrentOAuthToken | DELETE | Revokes the current OAuth token. |
Revoke TokenRevokeOAuthToken | DELETE | Allowed for Admins, Agents, End Users |
Show Current TokenShowCurrentToken | GET | Returns the properties of the current token. |
Show TokenShowToken | GET | Returns the properties of the specified token. |
Object Trigger10
Create Object TriggerCreateObjectTrigger | POST | Creates a new object trigger for a specified object. |
Delete Many Object TriggersDeleteManyObjectTriggers | DELETE | Deletes the object triggers corresponding to the provided comma-separated list of ids. |
Delete Object TriggerDeleteObjectTrigger | DELETE | Deletes a specified object trigger. |
List Active Object TriggersListActiveObjectTriggers | GET | Lists all active object triggers. |
List Object Trigger Action and Condition DefinitionsListObjectTriggersDefinitions | GET | Lists the conditions and actions of all triggers for the specified custom object. |
List Object TriggersListObjectTriggers | GET | Lists all triggers for the specified custom object. |
Search Object TriggersSearchObjectTriggers | GET | Returns a list of object triggers that meet your filter or search criteria. |
Show Object TriggerGetObjectTrigger | GET | Returns details of a specific object trigger. |
Update Many Object TriggersUpdateManyObjectTriggers | PUT | Updates the position or the active status of multiple object triggers. |
Update Object TriggerUpdateObjectTrigger | PUT | Updates a specified object trigger. |
Omnichannel Routing Queue7
Create QueueCreateQueue | POST | Creates a queue. |
Delete QueueDeleteQueue | DELETE | Deletes the queue and related records. |
List Queue DefinitionsListQueueDefinitions | GET | Returns the definitions of the queues and the definitions of the conditions under which a queue can execute. |
List queuesListQueues | GET | Returns all active queues for an account. |
Reorder QueuesReorderQueues | PATCH | Alters the evaluation order of OCR queues in the account. |
Show QueueShowQueueById | GET | Returns a queue for the given queue id. |
Update QueueUpdateQueue | PUT | Updates the queue definition for a given queue id. |
Organization19
Autocomplete OrganizationsAutocompleteOrganizations | GET | Returns an array of organizations whose name starts with the value specified in the name parameter. |
Bulk Delete OrganizationsDeleteManyOrganizations | DELETE | Accepts a comma-separated list of up to 100 organization ids or external ids. |
Count OrganizationsCountOrganizations | GET | Returns an approximate count of organizations. |
Count User's OrganizationsCountUserOrganizations | GET | Returns an approximate count of organizations for a specific user. |
Create Many OrganizationsCreateManyOrganizations | POST | Accepts an array of up to 100 organization objects. |
Create Or Update OrganizationCreateOrUpdateOrganization | POST | Creates an organization if it doesn't already exist, or updates an existing organization. |
Create OrganizationCreateOrganization | POST | You must provide a unique name for each organization. |
Delete OrganizationDeleteOrganization | DELETE | |
List Organization MergesListOrganizationMerges | GET | Retrieves a list of all organization merge operations associated with a given organization. |
List OrganizationsListOrganizations | GET | Pagination |
List User OrganizationsListUserOrganizations | GET | Returns a list of organizations associated with the specified user. |
Merge Organization With Another OrganizationCreateOrganizationMerge | POST | Merges two organizations by moving all users, tickets, and domain names from the organization specified by {organization id} to the organization specified by winner id. |
Search OrganizationsSearchOrganizations | GET | Returns an array of organizations matching the criteria. |
Show Many OrganizationsShowManyOrganizations | GET | Accepts a comma-separated list of up to 100 organization ids or external ids. |
Show OrganizationShowOrganization | GET | |
Show Organization MergeShowOrganizationMerge | GET | Retrieves the details of a specific organization merge operation. |
Show Organization's Related InformationOrganizationRelated | GET | |
Update Many OrganizationsUpdateManyOrganizations | PUT | Bulk or batch updates up to 100 organizations. |
Update OrganizationUpdateOrganization | PUT |
Organization Field6
Create Organization FieldCreateOrganizationField | POST | Creates any of the following custom field types: |
Delete Organization FieldDeleteOrganizationField | DELETE | |
List Organization FieldsListOrganizationFields | GET | Returns a list of custom organization fields in your account. |
Reorder Organization FieldReorderOrganizationField | PUT | |
Show Organization FieldShowOrganizationField | GET | |
Update Organization FieldUpdateOrganizationField | PUT | Updating a Dropdown (Tagger) or Multiselect Field |
Organization Membership14
Bulk Delete MembershipsDeleteManyOrganizationMemberships | DELETE | Immediately removes a user from an organization and schedules a job to unassign all working tickets currently assigned to the user and organization combination. |
Create Many MembershipsCreateManyOrganizationMemberships | POST | Accepts an array of up to 100 organization membership objects. |
Create MembershipCreateOrganizationMembership | POST | Assigns a user to a given organization. |
Create Organization Membership for UserCreateUserOrganizationMembership | POST | Assigns a user to a given organization. |
Delete MembershipDeleteOrganizationMembership | DELETE | Immediately removes a user from an organization and schedules a job to unassign all working tickets currently assigned to the user and organization combination. |
Delete Organization Membership for UserDeleteUserOrganizationMembership | DELETE | Immediately removes a user from an organization and schedules a job to unassign all working tickets currently assigned to the user and organization combination. |
List MembershipsListOrganizationMemberships | GET | Returns a list of organization memberships for the account, user or organization in question. |
List Organization Memberships by OrganizationListOrganizationMembershipsByOrganization | GET | Returns a list of organization memberships for the account, user or organization in question. |
List Organization Memberships by UserListUserOrganizationMemberships | GET | Returns a list of organization memberships for the account, user or organization in question. |
Set Membership as DefaultSetOrganizationMembershipAsDefault | PUT | Sets the default organization membership of a given user. |
Set Organization as DefaultSetOrganizationAsDefault | PUT | Sets the default organization membership of a given user. |
Show MembershipShowOrganizationMembershipById | GET | |
Show Organization Membership by UserShowOrganizationMembershipByUserId | GET | |
Unassign OrganizationUnassignOrganization | DELETE | Immediately removes a user from an organization and schedules a job to unassign all working tickets currently assigned to the user and organization combination. |
Organization Subscription6
Create Organization SubscriptionCreateOrganizationSubscription | POST | Allowed For: |
Delete Organization SubscriptionDeleteOrganizationSubscription | DELETE | Allowed For: |
List Organization SubscriptionsListOrganizationSubscriptions | GET | Pagination |
List Subscriptions By OrganizationListOrganizationSubscriptionsByOrganization | GET | Returns a list of organization subscriptions for a specific organization. |
List User's Organization SubscriptionsListUserOrganizationSubscriptions | GET | Returns a list of organization subscriptions for a specific user. |
Show Organization SubscriptionShowOrganizationSubscription | GET | Allowed For: |
Push Notification Device1
Bulk Unregister Push Notification DevicesPushNotificationDevices | POST | Unregisters the mobile devices that are receiving push notifications. |
Remote Authentication1
List Remote AuthenticationsListRemoteAuthentications | GET |
Request12
Create RequestCreateRequest | POST | Accepts a request object that sets one or more properties. |
Getting CommentsShowComment | GET | |
List CCD RequestsListCCDRequests | GET | Lists requests where the authenticated end user is CC'd. |
List Open RequestsListOpenRequests | GET | Lists requests with the "open" status for the authenticated end user. |
List Organization RequestsListOrganizationRequests | GET | Returns a list of requests for a specific organization. |
List RequestsListRequests | GET | |
List Solved RequestsListSolvedRequests | GET | Lists requests with the "solved" status for the authenticated end user. |
List User RequestsListUserRequests | GET | Lists requests for the specified user. |
Listing CommentsListComments | GET | Pagination |
Search RequestsSearchRequests | GET | Examples: |
Show RequestShowRequest | GET | Sideloads |
Update RequestUpdateRequest | PUT | Updates a request with a comment or collaborators (cc's). |
Reseller2
Create Trial AccountCreateTrialAccount | POST | |
Verify Subdomain AvailabilityVerifySubdomainAvailability | GET | Zendesk Support credentials are not required to access this endpoint. |
Resource Collection5
Create Resource CollectionCreateResourceCollection | POST | Creates a resource collection from a provided payload object. |
Delete Resource CollectionDeleteResourceCollection | DELETE | Deletes a specified resource collection. |
List Resource CollectionsListResourceCollections | GET | Lists resource collections for the account. |
Show Resource CollectionRetrieveResourceCollection | GET | Retrieves details for a specified resource collection. |
Update Resource CollectionUpdateResourceCollection | PUT | Updates a resource collection using a provided payload object. |
Satisfaction Rating4
Count Satisfaction RatingsCountSatisfactionRatings | GET | Returns an approximate count of satisfaction ratings in the account. |
Create a Satisfaction RatingCreateTicketSatisfactionRating | POST | Creates a CSAT rating for a solved ticket, or for a ticket that was previously solved and then reopened. |
List Satisfaction RatingsListSatisfactionRatings | GET | Allowed For Admins |
Show Satisfaction RatingShowSatisfactionRating | GET | Returns a specific satisfaction rating. |
Satisfaction Reason2
List Reasons for Satisfaction RatingListSatisfactionRatingReasons | GET | List all reasons for an account |
Show Reason for Satisfaction RatingShowSatisfactionRatings | GET |
Saved Search4
Create Saved SearchCreateSavedSearch | POST | Creates a saved search for the requesting agent. |
Delete Saved SearchDeleteSavedSearch | DELETE | Deletes the saved search with the specified id for the requesting agent. |
List Saved SearchesListSavedSearches | GET | Returns all saved searches for the requesting agent. |
Update Saved SearchUpdateSavedSearch | PUT | Updates the name, type, and query of the saved search with the specified id for the requesting agent. |
Search3
Export Search ResultsExportSearchResults | GET | Exports a set of results. |
List Search ResultsListSearchResults | GET | Returns the search results. |
Show Results CountCountSearchResults | GET | Returns the number of items matching the query rather than the items. |
Security Setting1
Show Security SettingsShowSecuritySettings | GET | Allowed For Admins |
Session8
Bulk Delete SessionsBulkDeleteSessionsByUserId | DELETE | Deletes all the sessions for a user. |
Delete SessionDeleteSession | DELETE | |
Delete the Authenticated SessionDeleteAuthenticatedSession | DELETE | Deletes the current session. |
List SessionsListSessions | GET | If authenticated as an admin, returns all the account's sessions. |
List Sessions for UserListUserSessions | GET | Lists all sessions for a specific user. |
Renew the current sessionRenewCurrentSession | GET | |
Show SessionShowSession | GET | |
Show the Currently Authenticated SessionShowCurrentlyAuthenticatedSession | GET |
Sharing Agreement5
Create Sharing AgreementCreateSharingAgreement | POST | |
Delete a Sharing AgreementDeleteSharingAgreement | DELETE | Deletes a sharing agreement. |
List Sharing AgreementsListSharingAgreements | GET | |
Show a Sharing AgreementShowSharingAgreement | GET | Returns a sharing agreement for your account. |
Update a Sharing AgreementUpdateSharingAgreement | PUT | Returns an updated sharing agreement. |
Skill Based Routing18
Bulk Set Agent Attribute Values JobsBulkSetAgentAttributeValuesJob | POST | Adds, replaces or removes multiple attributes for up to 100 agents. |
Create AttributeCreateAttribute | POST | Creates an attribute. |
Create Attribute ValueCreateAttributeValue | POST | Creates an attribute value. |
Delete AttributeDeleteAttribute | DELETE | Deletes an attribute. |
Delete Attribute ValueDeleteAttributeValue | DELETE | Deletes an attribute value. |
List Account AttributesListAccountAttributes | GET | Returns a list of attributes for the account. |
List Agent Attribute ValuesListAGentAttributeValues | GET | Returns an attribute value. |
List Attribute Values for an AttributeListAttributeValues | GET | Returns a list of attribute values for a provided attribute. |
List Attribute Values for Many AgentsListManyAgentsAttributeValues | GET | Accepts a comma-separated list of up to 100 agent ids and returns attribute values for each agent in the list. |
List Routing Attribute DefinitionsListRoutingAttributeDefinitions | GET | Returns the condition definitions that can be configured to apply attributes to a ticket. |
List Ticket Attribute ValuesListTicketAttributeValues | GET | Returns a list of attributes values for the ticket. |
List Tickets Fulfilled by a UserListTicketsFullfilledByUser | GET | Returns a list of ticket ids that contain attributes matching the current user's attributes. |
Set Agent Attribute ValuesSetAgentAttributeValues | POST | Adds the specified attributes if no attributes exists, or replaces all existing attributes with the specified attributes. |
Set Ticket Attribute ValuesSetTicketAttributeValues | POST | Adds the specified attributes if no attributes exists, or replaces all existing attributes with the specified attributes. |
Show AttributeShowAttribute | GET | Returns an attribute. |
Show Attribute ValueShowAttributeValue | GET | Returns an attribute value. |
Update AttributeUpdateAttribute | PUT | Updates an attribute. |
Update Attribute ValueUpdateAttributeValue | PATCH | Updates the name and ticket conditions of a skill. |
SLA Policy7
Create SLA PolicyCreateSLAPolicy | POST | Availability |
Delete SLA PolicyDeleteSLAPolicy | DELETE | Availability |
List SLA PoliciesListSLAPolicies | GET | Availability |
Reorder SLA PoliciesReorderSLAPolicies | PUT | Availability |
Retrieve Supported Filter Definition ItemsRetrieveSLAPolicyFilterDefinitionItems | GET | Availability |
Show SLA PolicyShowSLAPolicy | GET | Availability |
Update SLA PolicyUpdateSLAPolicy | PUT | Updates the specified policy. |
Support Address6
Create Support AddressCreateSupportAddress | POST | Adds a Zendesk or external support address to your account. |
Delete Support AddressDeleteRecipientAddress | DELETE | Deletes a support address. |
List Support AddressesListSupportAddresses | GET | Lists all the support addresses for the account. |
Show Support AddressShowSupportAddress | GET | |
Update Support AddressUpdateSupportAddress | PUT | Updates an existing support address for your account. |
Verify Support Address ForwardingVerifySupportAddressForwarding | PUT | Sends a test email to the specified support address to verify that email forwarding for the address works. |
Suspended Ticket9
Bulk Recover Suspended TicketsBulkRecoverSuspendedTickets | PUT | Enqueues a bulk job to recover multiple suspended tickets. |
Delete Multiple Suspended TicketsDeleteSuspendedTickets | DELETE | Accepts up to 100 ids (the auto-generated id, not the ticket id.) |
Delete Suspended TicketDeleteSuspendedTicket | DELETE | |
Export Suspended TicketsExportSuspendedTickets | POST | Exports a list of suspended tickets for the Zendesk Support instance. |
List Suspended TicketsListSuspendedTickets | GET | |
Recover Multiple Suspended TicketsRecoverSuspendedTickets | PUT | Accepts up to 100 ids (the auto-generated id, not the ticket id.) Note that suspended tickets that fail to be recovered are still included in the response. |
Recover Suspended TicketRecoverSuspendedTicket | PUT | Note : During recovery, the API sets the requester to the authenticated agent who called the API, not the original requester. |
Show Suspended TicketShowSuspendedTickets | GET | |
Suspended Ticket AttachmentsSuspendedTicketsAttachments | POST | Makes copies of any attachments on a suspended ticket and returns them as attachment tokens. |
Tag16
Add Organization TagsAddOrganizationTags | PUT | |
Add TagsPutTagsTicket | PUT | You can also add tags to multiple tickets with the Update Many Tickets endpoint. |
Add User TagsPutUserTags | PUT | |
Count TagsCountTags | GET | Returns an approximate count of tags. |
List Organization TagsListOrganizationTags | GET | |
List Resource TagsListResourceTags | GET | |
List TagsListTags | GET | Lists up to the 20,000 most popular tags in the last 60 days, in decreasing popularity. |
List User TagsListUserTags | GET | |
Remove Organization TagsRemoveOrganizationTags | DELETE | |
Remove TagsDeleteTagsTicket | DELETE | You can also delete tags from multiple tickets with the Update Many Tickets endpoint. |
Remove User TagsDeleteUserTags | DELETE | |
Search TagsAutocompleteTags | GET | Returns an array of registered and recent tag names that start with the characters specified in the name query parameter. |
Search Tags by Request BodyAutocompleteTagsPost | POST | Returns an array of registered and recent tag names that start with the characters specified in the name parameter. |
Set Organization TagsSetOrganizationTags | POST | |
Set TagsSetTagsTicket | POST | |
Set User TagsSetUserTags | POST |
Target5
Create TargetCreateTarget | POST | |
Delete TargetDeleteTarget | DELETE | Allowed For Admins |
List TargetsListTargets | GET | |
Show TargetShowTarget | GET | |
Update TargetUpdateTarget | PUT | Allowed For Admins |
Target Failure2
List Target FailuresListTargetFailures | GET | Returns the 25 most recent target failures, per target. |
Show Target FailureShowTargetFailure | GET | Stability |
Task List2
Create Task ListCreateTaskList | POST | Adds a task list to the specified ticket. |
Show Task ListShowTaskList | GET | Returns the task list attached to the specified ticket. |
Task List Template6
Create Task List TemplateCreateTaskListTemplate | POST | Creates a task list template. |
Delete Task List TemplateDeleteTaskListTemplate | DELETE | Deletes a task list template with the specified id. |
Get Tasks by Task List Template IdGetTasksByTaskListTemplateId | GET | Returns the tasks for the specified task list template. |
List Task List TemplatesListTaskListTemplates | GET | Lists all task list templates. |
Show Task List TemplateShowTaskListTemplate | GET | Returns the task list template with the specified id. |
Update Task List TemplateUpdateTaskListTemplate | PUT | Creates, modifies, or deletes tasks in a task list template. |
Ticket35
Autocomplete ProblemsAutocompleteProblems | POST | Returns tickets whose type is "problem" and whose subject contains the string specified in the text parameter. |
Bulk Delete TicketsBulkDeleteTickets | DELETE | Accepts a comma-separated list of up to 100 ticket ids. |
Bulk Mark Tickets as SpamMarkManyTicketsAsSpam | PUT | Accepts a comma-separated list of up to 100 ticket ids. |
Count Organization TicketsCountOrganizationTickets | GET | Returns an approximate count of tickets for a specific organization. |
Count TicketsCountTickets | GET | Returns an approximate count of tickets in the account. |
Count User Assigned TicketsCountUserAssignedTickets | GET | Returns an approximate count of tickets assigned to the specified user. |
Count User CCD TicketsCountUserCCDTickets | GET | Returns an approximate count of tickets where the specified user is CC'd. If the count exceeds 100,000, it is updated every 24 hours. |
Create Many TicketsTicketsCreateMany | POST | Accepts an array of up to 100 ticket objects. |
Create TicketCreateTicket | POST | |
Delete Multiple Tickets PermanentlyBulkPermanentlyDeleteTickets | DELETE | Permanently deletes up to 100 soft-deleted tickets. |
Delete TicketDeleteTicket | DELETE | |
Delete Ticket PermanentlyDeleteTicketPermanently | DELETE | Permanently deletes a soft-deleted ticket. |
List Collaborators for a TicketListTicketCollaborators | GET | |
List Deleted TicketsListDeletedTickets | GET | Returns a maximum of 100 deleted tickets per page. |
List Email CCs for a TicketListTicketEmailCCs | GET | Returns any users cc'd on the ticket. |
List Followers for a TicketListTicketFollowers | GET | Returns any users who follow the ticket. |
List Organization TicketsListOrganizationTickets | GET | Returns a list of tickets for a specific organization. |
List Recent TicketsListRecentTickets | GET | Lists up to five tickets that the requesting agent recently viewed or created in the agent interface. |
List Ticket IncidentsListTicketIncidents | GET | |
List Ticket ProblemsListTicketProblems | GET | The response is always ordered by updated at in descending order |
List TicketsListTickets | GET | |
List User Assigned TicketsListUserAssignedTickets | GET | Lists tickets assigned to the specified user. |
List User CCD TicketsListUserCCDTickets | GET | Lists tickets where the specified user is CC'd. |
List User Followed TicketsListUserFollowedTickets | GET | Lists tickets the specified user is following. |
List User Requested TicketsListUserRequestedTickets | GET | |
Mark Ticket as Spam and Suspend RequesterMarkTicketAsSpamAndSuspendRequester | PUT | |
Merge Tickets into Target TicketMergeTicketsIntoTargetTicket | POST | Merges one or more tickets into the ticket with the specified id. |
Restore a Previously Deleted TicketRestoreDeletedTicket | PUT | |
Restore Previously Deleted Tickets in BulkBulkRestoreDeletedTickets | PUT | |
Show Multiple TicketsTicketsShowMany | GET | Accepts a comma-separated list of ticket ids to return. |
Show TicketShowTicket | GET | Returns a number of ticket properties, but doesn't include the full comment thread. |
Show Ticket by Messaging Conversation IDShowTicketByMessagingConversationId | GET | Returns the active ticket associated with the given Sunshine Conversations conversation id. |
Ticket Related InformationTicketRelatedInformation | GET | The request returns a data object with the following properties: |
Update Many TicketsTicketsUpdateMany | PUT | Accepts an array of up to 100 ticket objects, or a comma-separated list of up to 100 ticket ids. |
Update TicketUpdateTicket | PUT |
Ticket Audit5
Change a Comment From Public To PrivateMakeTicketCommentPrivateFromAudits | PUT | |
Count Audits for a TicketCountAuditsForTicket | GET | Returns an approximate count of audits for a specified ticket. |
List All Ticket AuditsListTicketAudits | GET | Returns ticket audits. |
List Audits for a TicketListAuditsForTicket | GET | Lists the audits for a specified ticket. |
Show AuditShowTicketAudit | GET |
Ticket Comment7
Count Ticket CommentsCountTicketComments | GET | Returns an approximate count of the comments added to the ticket. |
List CommentsListTicketComments | GET | Returns the comments added to the ticket. |
Make Comment PrivateMakeTicketCommentPrivate | PUT | |
Redact Chat CommentRedactChatComment | PUT | Permanently removes words or strings from a chat ticket's comment. |
Redact Chat Comment AttachmentRedactChatCommentAttachment | PUT | Permanently removes one or more chat attachments from a chat ticket. |
Redact String in CommentRedactStringInComment | PUT | Permanently removes words or strings from a ticket comment. |
Redact Ticket Comment In Agent WorkspaceRedactTicketCommentInAgentWorkspace | PUT | Redaction allows you to permanently remove words, strings, or attachments from a ticket comment. |
Ticket Content Pin3
Create Ticket Content PinCreateTicketContentPin | POST | Creates a new content pin for a specific ticket. |
Delete Content Pin from TicketDeleteTicketContentPin | DELETE | Deletes a specific content pin from a ticket. |
List Ticket Content PinsListTicketContentPins | GET | Lists the content pins for a specific ticket. |
Ticket Field12
Count Ticket FieldsCountTicketFields | GET | Returns an approximate count of system and custom ticket fields in the account. |
Create or Update Ticket Field OptionCreateOrUpdateTicketFieldOption | POST | Creates or updates an option for the given drop-down ticket field. |
Create Ticket FieldCreateTicketField | POST | Creates any of the following custom field types: |
Delete Ticket FieldDeleteTicketField | DELETE | |
Delete Ticket Field OptionDeleteTicketFieldOption | DELETE | Allowed for Admins |
List Ticket Field OptionsListTicketFieldOptions | GET | Returns a list of custom ticket field options for the given drop-down ticket field. |
List Ticket FieldsListTicketFields | GET | Returns a list of all system and custom ticket fields in your account. |
Reorder Ticket FieldsReorderTicketFields | PUT | Allowed For Admins |
Show Many Ticket FieldsShowManyTicketFields | GET | Returns multiple ticket fields in a single request. |
Show Ticket FieldShowTicketfield | GET | |
Show Ticket Field OptionShowTicketFieldOption | GET | Allowed for Agents |
Update Ticket FieldUpdateTicketField | PUT | Updating drop-down field options |
Ticket Form12
Bulk Update Ticket Form Statuses of a Ticket FormUpdateTicketFormStatuses | PUT | Updates or deletes ticket form status associations. |
Clone an Already Existing Ticket FormCloneTicketForm | POST | |
Create Ticket FormCreateTicketForm | POST | |
Create Ticket Form StatusesCreateTicketFormStatuses | POST | Creates one or many ticket form status associations |
Delete Ticket FormDeleteTicketForm | DELETE | Allowed For Admins |
List Ticket Form Statuses of a Ticket FormTicketFormTicketFormStatuses | GET | Fetches all of the associated ticket form statuses of a ticket form. |
List Ticket FormsListTicketForms | GET | Returns a list of all ticket forms for your account if accessed as an admin or agent. |
Reorder Ticket FormsReorderTicketForms | PUT | Allowed For Admins |
Show Many Ticket FormsShowManyTicketForms | GET | Takes an ids query parameter that accepts a comma-separated list of up to 100 ticket form ids. |
Show Ticket FormShowTicketForm | GET | |
Update Ticket FormUpdateTicketForm | PUT | Allowed For Admins |
Update Ticket Form Status By IdUpdateTicketFormStatusById | PUT | Updates or deletes ticket form status association by id. |
Ticket Form Statuse4
Delete Ticket Form Status By IdDeleteTicketFormStatusById | DELETE | Deletes a ticket form status by id. |
Delete Ticket Form StatusesDeleteTicketFormStatuses | DELETE | Deletes all of of the ticket form statuses by id. |
List Ticket Form StatusesListTicketFormStatuses | GET | Fetches all of the ticket form statuses for the account. |
Show Many Ticket Form StatusesShowManyTicketFormStatuses | GET | Fetches all of the ticket form statuses specified by a comma separated list of ids. |
Ticket Import2
Ticket Bulk ImportTicketBulkImport | POST | Accepts an array of up to 100 ticket objects. |
Ticket ImportTicketImport | POST |
Ticket Metric3
List Ticket MetricsListTicketMetrics | GET | Returns a list of tickets with their metrics. |
Show Ticket MetricsShowTicketMetrics | GET | Returns a specific metric, or the metrics of a specific ticket. |
Show Ticket Metrics By TicketShowTicketMetricsByTicket | GET | Returns the metrics for a specific ticket. |
Ticket Metric Event1
List Ticket Metric EventsListTicketMetricEvents | GET | Returns ticket metric events that occurred on or after the start time. |
Ticket Skip4
List All SkipsListSkips | GET | Lists all skips. |
List Ticket SkipsListTicketSkips | GET | Archived tickets are not included in the response. |
List Ticket Skips By TicketListTicketSkipsByTicket | GET | Returns the skips for a specific ticket. |
Record a New Skip for the Current UserRecordNewSkip | POST | Record a new ticket skip for the current user. |
Trigger13
Bulk Delete Ticket TriggersDeleteManyTriggers | DELETE | Deletes the ticket triggers corresponding to the provided comma-separated list of IDs. |
Create TriggerCreateTrigger | POST | |
Delete Ticket TriggerDeleteTrigger | DELETE | |
List Active Ticket TriggersListActiveTriggers | GET | Lists all active ticket triggers. |
List Ticket Trigger Action and Condition DefinitionsListTriggerActionConditionDefinitions | GET | Returns the definitions of the actions a ticket trigger can perform and the definitions of the conditions under which a ticket trigger can execute. |
List Ticket Trigger RevisionsListTriggerRevisions | GET | List the revisions associated with a ticket trigger. |
List Ticket TriggersListTriggers | GET | Lists all ticket triggers for the current account. |
Reorder Ticket TriggersReorderTriggers | PUT | Alters the firing order of ticket triggers in the account. |
Search Ticket TriggersSearchTriggers | GET | Pagination |
Show Ticket TriggerGetTrigger | GET | |
Show Ticket Trigger RevisionTriggerRevision | GET | Fetches a revision associated with a ticket trigger. |
Update Many Ticket TriggersUpdateManyTriggers | PUT | Updates the position or the active status of multiple ticket triggers. |
Update Ticket TriggerUpdateTrigger | PUT |
Trigger Category6
Create Batch Job for Ticket Trigger CategoriesBatchOperateTriggerCategories | POST | Creates a job that performs a batch operation for the given ticket trigger categories. |
Create Ticket Trigger CategoryCreateTriggerCategory | POST | Creates a ticket trigger category. |
Delete Ticket Trigger CategoryDeleteTriggerCategory | DELETE | Deletes the ticket trigger category with the specified ID. |
List Ticket Trigger CategoriesListTriggerCategories | GET | Returns all the ticket trigger categories in the account. |
Show Ticket Trigger CategoryShowTriggerCategoryById | GET | Returns the ticket trigger category with the specified ID. |
Update Ticket Trigger CategoryUpdateTriggerCategory | PATCH | Updates the ticket trigger category with the specified ID. |
User32
Autocomplete UsersAutocompleteUsers | GET | Returns an array of users whose name starts with the value specified in the name parameter. |
Autocomplete Users by Request BodyAutocompleteUsersPost | POST | Returns an array of users whose name starts with the value specified in the name property in the request body. |
Bulk Delete UsersDestroyManyUsers | DELETE | Accepts a comma-separated list of up to 100 user ids. |
Count Deleted UsersCountDeletedUsers | GET | Returns an approximate count of deleted users, including permanently deleted users. |
Count Organization UsersCountOrganizationUsers | GET | Returns an approximate count of users for a specific organization. |
Count UsersCountUsers | GET | Returns an approximate count of users. |
Count Users By GroupCountGroupUsers | GET | Returns an approximate count of users in the specified group. |
Create Many UsersCreateManyUsers | POST | Accepts an array of up to 100 user objects. |
Create Or Update Many UsersCreateOrUpdateManyUsers | POST | Accepts an array of up to 100 user objects. |
Create Or Update UserCreateOrUpdateUser | POST | Creates a user if the user does not already exist, or updates an existing user identified by e-mail address or external ID. |
Create UserCreateUser | POST | |
Delete UserDeleteUser | DELETE | Deletes the user and associated records from the account. |
Get Full User EntitlementsGetUserEntitlementsFull | GET | Returns the full entitlements for all Zendesk products (Explore, Voice, Knowledge, Live Chat) for the specified user. |
List Deleted UsersListDeletedUsers | GET | Returns deleted users, including permanently deleted users. |
List Organization UsersListOrganizationUsers | GET | Returns a list of users for a specific organization. |
List UsersListUsers | GET | Pagination |
List Users By GroupListGroupUsers | GET | Pagination |
Logout many usersLogoutManyUsers | POST | Accepts a comma-separated list of up to 100 user ids. |
Merge End UsersMergeEndUsers | PUT | Merges the end user specified in the path parameter into the existing end user specified in the request body. |
Permanently Delete UserPermanentlyDeleteUser | DELETE | Before permanently deleting a user, you must delete the user first. |
Request User CreateRequestUserCreate | POST | Sends the owner a reminder email to update their subscription so more agents can be created. |
Search UsersSearchUsers | GET | Returns an array of users who meet the search criteria. |
Show Compliance Deletion StatusesShowUserComplianceDeletionStatuses | GET | Returns the GDPR status for each user per area of compliance. |
Show Current User SettingsShowCurrentUserSettings | GET | Returns the settings for the currently authenticated user. |
Show Deleted UserShowDeletedUser | GET | Returns users that have been deleted but not permanently yet. |
Show Many UsersShowManyUsers | GET | Accepts a comma-separated list of up to 100 user ids or external ids. |
Show SelfShowCurrentUser | GET | The endpoint returns user information and an authenticity token. |
Show UserShowUser | GET | |
Show User Related InformationShowUserRelated | GET | |
Update Current User SettingsUpdateCurrentUserSettings | PUT | Updates the settings for the currently authenticated user. |
Update Many UsersUpdateManyUsers | PUT | |
Update UserUpdateUser | PUT |
User Field11
Create or Update a User Field OptionCreateOrUpdateUserFieldOption | POST | Creates a new option or updates an existing option for the given drop-down user field. |
Create User FieldCreateUserField | POST | Creates any of the following custom field types: |
Delete User FieldDeleteUserField | DELETE | |
Delete User Field OptionDeleteUserFieldOption | DELETE | Allowed for Admins |
List User Field OptionsListUserFieldOptions | GET | Returns a list of custom user field options for the given dropdown user field. |
List User FieldsListUserFields | GET | Returns a list of custom user fields in your account. |
Reorder User FieldReorderUserField | PUT | |
Show a User Field OptionShowUserFieldOption | GET | Allowed for Agents |
Show Many User FieldsShowManyUserFields | GET | Returns multiple user fields by their keys. |
Show User FieldShowUserField | GET | |
Update User FieldUpdateUserField | PUT | Updating a Dropdown (Tagger) or Multiselect Field |
User Identity14
Create End User IdentityCreateEndUserIdentity | POST | Adds an identity to an end user's profile. |
Create IdentityCreateUserIdentity | POST | Adds an identity to a user's profile. |
Delete End User IdentityDeleteEndUserIdentity | DELETE | Deletes the identity for a given end user. |
Delete IdentityDeleteUserIdentity | DELETE | Deletes the identity for a given user. |
List End User IdentitiesListEndUserIdentities | GET | Returns a list of identities for the given end user. |
List IdentitiesListUserIdentities | GET | Returns a list of identities for the given user. |
Make End User Identity PrimaryMakeEndUserIdentityPrimary | PUT | Sets the specified identity as primary for the end user. |
Make Identity PrimaryMakeUserIdentityPrimary | PUT | Sets the specified identity as primary. |
Request End User VerificationRequestEndUserVerification | PUT | Sends the end user a verification email with a link to verify ownership of the email address. |
Request User VerificationRequestUserVerification | PUT | Sends the user a verification email with a link to verify ownership of the email address. |
Show End User IdentityShowEndUserIdentity | GET | Shows the identity with the given id for a given end user. |
Show IdentityShowUserIdentity | GET | Shows the identity with the given id for a given user. |
Update IdentityUpdateUserIdentity | PUT | This endpoint allows you to: |
Verify IdentityVerifyUserIdentity | PUT | Sets the specified identity as verified. |
User Password3
Change Your PasswordChangeOwnPassword | PUT | You can only change your own password. |
List password requirementsGetUserPasswordRequirements | GET | |
Set a User's PasswordSetUserPassword | POST | An admin can set a user's password only if the setting is enabled in Zendesk Support under Settings Security Global . |
View20
Bulk Delete ViewsBulkDeleteViews | DELETE | Deletes the views corresponding to the provided list of IDs. |
Count Tickets in ViewGetViewCount | GET | Returns the ticket count for a single view. |
Count Tickets in ViewsGetViewCounts | GET | Returns the ticket count of each view in a list of views. |
Count ViewsCountViews | GET | Returns an approximate count of shared and personal views available to the current user. |
Create ViewCreateView | POST | |
Delete ViewDeleteView | DELETE | Allowed For Agents |
Execute ViewExecuteView | GET | Returns the column titles and the rows of the specified view. |
Export ViewExportView | GET | Returns the csv attachment of the specified view if possible. |
List Active ViewsListActiveViews | GET | Lists active shared and personal views available to the current user. |
List Tickets From a ViewListTicketsFromView | GET | |
List View Filter DefinitionsListViewDefinitions | GET | Returns the definitions of the conditions and actions a view can perform. |
List ViewsListViews | GET | Lists shared and personal views available to the current user. |
List Views - CompactListCompactViews | GET | A compacted list of shared and personal views available to the current user. |
List Views By IDListViewsById | GET | |
Preview Ticket CountPreviewCount | POST | Returns the ticket count for a single preview. |
Preview ViewsPreviewViews | POST | You can preview views by constructing the conditions in the proper format and nesting them under the view property. |
Search ViewsSearchViews | GET | Pagination |
Show ViewShowView | GET | In addition to numeric IDs, the view id path parameter accepts the string aliases "incoming", "my", and "my groups" to retrieve the corresponding built-in views. |
Update Many ViewsUpdateManyViews | PUT | |
Update ViewUpdateView | PUT |
Workspace7
Bulk Delete WorkspacesDestroyManyWorkspaces | DELETE | Allowed For Admins |
Create WorkspaceCreateWorkspace | POST | |
Delete WorkspaceDeleteWorkspace | DELETE | Allowed For Admins |
List WorkspacesListWorkspaces | GET | |
Reorder WorkspacesReorderWorkspaces | PUT | Allowed For Admins |
Show WorkspaceShowWorkspace | GET | Allowed For Admins |
Update WorkspaceUpdateWorkspace | PUT | Allowed For Admins |
X Channel4
Create Ticket from TweetCreateTicketFromTweet | POST | Turns a tweet into a ticket. |
List Monitored X HandlesListMonitoredTwitterHandles | GET | |
List Ticket statusesGettingTwicketStatus | GET | |
Show Monitored X HandleShowMonitoredTwitterHandle | GET |