Zendesk

Add organization tags in Zendesk. Use when you need to tag an organization for categorization, filtering, or automation purposes. Tags are appended to the organization's existing tags. This action is idempotent — adding the same tag multiple times will not create duplicates in the organization's tag list.

Preview how a Zendesk macro would affect a ticket without actually applying it. Returns the ticket object as it would appear after the macro is applied, showing any changes to fields, comments, status, or other properties. Use this action to review macro changes before applying them to ensure the outcome is as expected.

Search for Zendesk organizations using autocomplete. Use when you need to find organization suggestions based on a partial organization name for ticket creation, user assignment, or organization lookup. The `name` parameter is required - provide at least a few characters for meaningful autocomplete results. Returns organizations sorted by relevance.

Autocomplete problems in Zendesk. Use when you need to find problem suggestions based on a partial search text for ticket categorization or troubleshooting.

Search for Zendesk users by name prefix using the POST /api/v2/users/autocomplete endpoint. Returns an array of users whose name starts with the provided query. Use when you need to find users by name prefix for quick user lookup and autocomplete functionality.

Autocomplete users by name or phone number. Use when you need to find users based on a partial name or phone number for ticket creation or user lookup scenarios. At least one of 'name' or 'phone' must be provided.

Permanently deletes multiple soft-deleted tickets in Zendesk. This action is irreversible — the tickets will be permanently removed and cannot be recovered once executed. Use when cleaning up test tickets or removing obsolete soft-deleted tickets in bulk. The operation returns a job_status payload (initial status typically 'queued'); deletions complete asynchronously and may require follow-up polling to confirm completion. Maximum 100 tickets per request.

Bulk delete automations in Zendesk. This action is irreversible — the automations will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete automations or removing test data.

Bulk delete triggers for a Zendesk custom object. This action is irreversible — the triggers will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete triggers or removing test data for a specific custom object. Returns a success indicator upon completion. Requires the custom object key and a comma-separated list of trigger IDs to identify which triggers to delete.

Bulk delete group memberships in Zendesk. Immediately removes users from groups. This action is irreversible — the memberships will be permanently deleted and cannot be recovered once removed. Use when cleaning up test data or removing obsolete group memberships in one call. Returns a job_status payload; deletions complete asynchronously.

Bulk delete macros in Zendesk. This action is irreversible — the macros will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete macros or removing test data.

Bulk delete organization memberships in Zendesk. This action is irreversible — the memberships will be permanently removed and cannot be recovered once deleted. Use when cleaning up obsolete organization memberships or removing users from organizations. Returns a job_status payload (initial status typically 'queued'); deletions complete asynchronously and may require follow-up polling to confirm completion.

Bulk delete Zendesk organizations. This action is irreversible - once organizations are deleted, they cannot be recovered. Use when you need to remove multiple organizations in a single operation. Returns a job_status payload (initial status typically 'queued'); deletions complete asynchronously and may require follow-up polling to confirm completion. Maximum 100 organizations per request. Use this action when you need to clean up test data, remove obsolete organizations, or perform bulk organization deletions. You must provide either 'ids' (comma-separated list of Zendesk organization IDs) or 'external_ids' (comma-separated list of external IDs).

Permanently deletes multiple suspended tickets in Zendesk. This action is irreversible — the suspended tickets will be permanently deleted and cannot be recovered once removed. Use when cleaning up spam or irrelevant suspended tickets. Accepts up to 100 ticket IDs per request.

Bulk delete users from Zendesk by their IDs or external IDs. This action is irreversible — once deleted, users cannot be recovered. Use when cleaning up test data, removing obsolete accounts, or consolidating user records in bulk. The operation returns a job_status payload (initial status typically 'queued'); deletions complete asynchronously and may require follow-up polling via the job_status URL to confirm completion.

Bulk delete views in Zendesk. This action is irreversible — the views will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete views or removing test data. Returns 204 No Content on success.

Bulk import tickets into Zendesk by posting up to 100 ticket objects at a time. Use when migrating tickets from another system or creating multiple tickets in a single API call. The operation returns a job_status payload; the initial status is typically 'queued' or 'completed' for small batches. This action is useful for data migration, test data setup, and bulk ticket creation workflows.

Bulk unregister push notification devices in Zendesk. This action is irreversible — the devices will be permanently removed from receiving push notifications and cannot be recovered once removed. Use when cleaning up obsolete device tokens or removing test devices from receiving push notifications.

Check the host mapping validity for an existing brand in Zendesk. Returns the current CNAME record, expected CNAME values, validity status, and the reason for validity or invalidity. Use this action when you need to verify that DNS records are correctly configured for an existing brand that has already been created in Zendesk. This action requires a brand ID rather than subdomain/host_mapping parameters.

Count ticket activities in Zendesk. Returns an approximate count of ticket activities. Use when you need to know how many activities exist in the activity stream for reporting or operational purposes.

Count the number of records in a specific Zendesk custom object. Use when you need to determine the total number of records for a custom object type, which is useful for reporting, capacity planning, or validation before creating new records. This is a read-only, idempotent operation. Example use cases: - Check if a custom object has records before deleting - Get record count for reporting dashboards - Verify capacity before bulk operations

Count deleted users in Zendesk. Returns the total number of deleted users. Use when you need to know how many users have been deleted for reporting, cleanup, or operational purposes.

Count groups in Zendesk. Returns an approximate count of groups in the system. Use when you need to know how many groups exist for reporting, organizational management, or operational purposes. This action is read-only and idempotent.

Count organization tickets in Zendesk. Returns an approximate count of tickets for a specific organization. Use when you need to know how many tickets are associated with an organization for reporting or operational purposes.

Count users in a specific Zendesk organization by ID. Returns an approximate count of users. Use when you need to know how many users belong to a particular organization for reporting or operational purposes.

Count satisfaction ratings in Zendesk. Returns an approximate count of satisfaction ratings. Use when you need to know how many satisfaction ratings exist for reporting or operational purposes.

Count Tags in Zendesk. Returns an approximate count of tags. Use when you need to know how many tags exist in your Zendesk account for reporting or operational purposes.

Count audits for a specific ticket in Zendesk. Returns an approximate count of audits associated with the specified ticket. Use when you need to know how many audit records exist for a ticket for reporting, analytics, or operational purposes.

Count comments on a Zendesk ticket. Returns an approximate count of comments added to the specified ticket. Use when you need to know how many comments exist on a ticket without fetching the full comment list, such as for reporting or determining if pagination is needed.

Count ticket fields in Zendesk. Returns an approximate count of system and custom ticket fields. Use when you need to know how many ticket fields exist for reporting or operational purposes.

Count tickets in a specific view in Zendesk. Returns the number of tickets matching the view's conditions. Use when you need to know how many tickets are in a particular view for reporting, routing decisions, or workload assessment. The count may be null if the system is still loading and caching new data. This action is read-only and idempotent.

Count tickets in multiple Zendesk views. Returns the ticket count for each view ID provided in a single API call. Use when you need to quickly get counts for multiple views at once for reporting or dashboard purposes. Note: This is a read-only, idempotent operation. Counts may be cached on the server side.

Count tickets assigned to a specific user in Zendesk. Returns an approximate count of tickets where the user is the assignee. Use when you need to know how many tickets are currently assigned to a particular user for workload analysis, reporting, or capacity planning. Note: The count is approximate and may not reflect real-time changes. The count is refreshed periodically rather than being calculated on every request.

Count tickets where the specified user is CCD (carbon copy distribution). Returns an approximate count of tickets where the user appears in the CCD field. Use when you need to know how many tickets a user is copied on for reporting or operational purposes.

Count user groups in Zendesk. Returns an approximate count of groups that a specific user belongs to. Use when you need to know how many groups a user is assigned to for reporting, organizational management, or operational purposes. This action is read-only and idempotent.

Count users in Zendesk. Returns an approximate count of users. If the count is more than 1000, the value is an estimate and the response is refreshed every 24 hours. Use when you need to know how many users exist in the system for reporting or administrative purposes.

Count users in a specific Zendesk group. Returns an approximate count of users belonging to the specified group, with optional filtering by role or permission set. Use when you need to know how many users are in a particular group for reporting, resource planning, or administrative purposes. This action is read-only and idempotent.

Count shared and personal views in Zendesk. Returns an approximate count of all views (both shared and personal) available in the account. Use when you need to know the total number of views configured for reporting or operational purposes.

Count the number of organizations in Zendesk. Returns an approximate count of organizations with the timestamp of when the count was last calculated. This is a read-only, idempotent operation. Use when you need to know the total number of organizations for reporting, capacity planning, or operational purposes. For detailed per-organization information, use ZENDESK_GET_ALL_ZENDESK_ORGANIZATIONS instead.

Count the number of tickets in Zendesk. Returns an approximate count of tickets with the timestamp of when the count was last calculated. This is a read-only, idempotent operation. Use when you need to know the total number of tickets for reporting, capacity planning, or operational purposes. Note that the count is approximate and may not reflect real-time changes. For detailed per-ticket information, use ZENDESK_LIST_ZENDESK_TICKETS instead.

Create an access rule for a custom object in Zendesk. Access rules control which users can view or modify custom object records based on conditions. Use when you need to set up data access policies for custom objects, such as limiting access to records created by the current user or records assigned to specific groups. Returns the created access rule with its ID, title, description, conditions, and timestamps.

Search for Zendesk tags using autocomplete via POST request body. Use when you need to find tag suggestions based on a partial tag name for tagging tickets or organizing content.

Create a new automation in Zendesk. Automations are business rules that automatically perform actions on tickets when certain conditions are met. Automations run server-side and don't require user interaction. Use this action when you need to: - Automatically assign tickets based on conditions - Change ticket priority/status based on rules - Add tags to tickets matching certain criteria - Notify agents or teams based on ticket properties - Implement escalation workflows Note: Automations must have at least one condition that is time-based (like created_at, updated_at) OR check one of: status, type, group_id, assignee_id, or requester_id.

Create a bookmark for a ticket in Zendesk. Bookmarks allow you to save references to tickets for quick access. Use this action when you need to: - Save a ticket for later reference - Mark an important ticket for quick access - Create a watchlist-like functionality for specific tickets

Create a bulk job to perform batch operations (create, update, delete, upsert) on custom object records in Zendesk. Use when you need to process multiple records of a custom object type efficiently in a single API call. Returns a job ID for tracking the operation progress via GET /api/v2/custom_objects/{custom_object_key}/jobs/{job_id}.

Create a new record for a custom object in Zendesk. Use when you need to add a new entry to a custom object type. The record is identified by its unique ID returned in the response. This action creates a new custom object record and returns the complete record data including the generated ID and timestamps.

Create an attachment for a custom object record in Zendesk. Use when you need to attach files (documents, images, etc.) to a custom object record. The file is uploaded as a multipart/form-data request. The response includes the attachment details and malware scan status.

Create a new custom ticket status in Zendesk. Custom statuses allow agents to define more granular ticket states beyond the default status categories. Use when you need to add custom ticket workflow states to better reflect your support process. Both `agent_label`, `status_category`, `end_user_label`, and `description` are required. The status category determines which lifecycle phase the custom status belongs to.

Create a new deletion schedule in Zendesk that automatically deletes records matching specified conditions on a schedule. Deletion schedules are used for data retention and cleanup policies. Use this action when you need to: - Automatically clean up old closed tickets - Remove inactive users or attachments - Enforce data retention policies - Schedule periodic deletion of bot conversations Note: The 'object' field (entity type to delete) cannot be modified after creation. Use conditions to specify which records to delete - for time-based deletion, use 'duration_since_last_update' field with 'greater_than' operator and ISO 8601 duration values (e.g., 'P30D' for 30 days).

Add an identity (email or phone) to an end user's profile in Zendesk. Use when you need to link a new email address or phone number to an existing end user account.

Create many locale variants for an existing dynamic content item in Zendesk. Use when you need to add multiple language variants to a dynamic content item in a single operation. This action is efficient for bulk-adding translations to support multilingual content. This action is idempotent - running it multiple times with the same variants will create duplicate variants if they don't already exist. Consider listing existing variants first to avoid duplicates.

Create multiple organization memberships in Zendesk by posting up to 100 membership objects at a time. Each membership links a user to an organization. Use when onboarding multiple users to organizations in bulk, such as during team migrations or organizational restructuring. The operation returns a job_status payload; the initial status is typically 'queued' for larger batches.

Create many tickets in Zendesk in a single request. Accepts an array of up to 100 ticket objects. The operation is handled asynchronously — a background job is queued and you receive a job_status payload with an initial status of 'queued' or 'working'. Poll the job_status URL or use ZENDESK_GET_APPS_JOB_STATUS to check for completion and view per-ticket results. Use when creating multiple tickets at once or seeding test data. This action is irreversible — tickets created cannot be easily undone once the job completes. Ensure the tickets list is accurate before submitting.

Create many users in Zendesk in a single request. Accepts up to 100 user objects. The operation is handled asynchronously — a background job is queued and you receive a job_status payload with an initial status of 'queued' or 'working'. Poll the job_status URL or use ZENDESK_GET_APPS_JOB_STATUS to check for completion and view per-user results. Use when onboarding multiple users at once or seeding test data. Note: This action is idempotent — re-running with the same external_ids may update existing users depending on Zendesk configuration.

Create a new trigger for a custom object in Zendesk. Custom object triggers are business rules that automatically perform actions when certain conditions are met on custom object records. Use this action when you need to: - Send notifications when custom object records are created or updated - Automatically update fields on custom object records - Add or remove tags based on custom object conditions - Implement automated workflows for custom object data This action is idempotent - creating a trigger with the same name multiple times will result in duplicate triggers unless the name is changed.

Create or update multiple users in Zendesk in a single request. Use when you need to batch create or update up to 100 users at once. New users require a 'name' field; existing users are matched by 'id'. Returns a job_status with results for each operation. This action is idempotent — re-running with the same parameters will produce the same results.

Create or update a Zendesk organization in a single operation. If an organization with the same external_id already exists, it is updated. Otherwise, a new organization is created. Use when you need to ensure an organization exists without checking for duplicates first. Note: For updates, you must specify the external_id to match the existing organization. Name is not available as a matching criteria.

Create or update a Zendesk user. If a user with the same email or external_id exists, it updates that user. Otherwise, it creates a new user. Use when you need to upsert user records - idempotent based on email or external_id matching. Returns 200 for existing users, 201 for newly created users.

Create a custom organization field in Zendesk. Use when you need to add a new custom field type (such as text, dropdown, checkbox, date, etc.) to track additional organization attributes. The field key must be unique and can only contain letters, numbers, and underscores.

Create a new organization membership in Zendesk by assigning a user to an organization. Use when you need to associate a user with an organization so they can access organization-specific tickets and data. Returns a 422 error if the user is already assigned to the organization. This action is idempotent in that creating a duplicate membership will fail with a specific error, but the operation itself is not naturally idempotent.

Create an organization subscription in Zendesk. This subscribes a user to receive notifications and updates related to a specific organization. Use when you need to add a user to an organization's subscription list so they can access organization-related resources and receive notifications.

Create a resource collection in Zendesk. Use when you need to batch multiple operations on Zendesk resources (like tickets) into a single request. The API processes the collection as a background job and returns a job status object. Note: This action queues a background job. Poll the returned job_status.url to check when the collection has been processed.

Create a private side conversation on a Zendesk ticket. Side conversations are agent-to-agent communications that don't notify the customer. Use this action when you need to discuss a ticket privately with another agent, escalate to a specialist, or coordinate on sensitive issues without customer visibility. Recipients can include Zendesk users (by ID or email), Slack channels, support groups, or Microsoft Teams channels.

Create a new support address (recipient address) in Zendesk. Use when you need to add a new email address for receiving support requests. The email address must follow Zendesk's format (`{local-part}@{accountname}.zendesk.com`) for internal addresses, or be an existing external email with forwarding properly configured. The created address will have verification statuses that indicate whether DNS records (CNAME, SPF) are properly configured. Note that you cannot change the email address of an existing support address after creation.

Create a ticket content pin in Zendesk. Content pins allow you to attach helpful resources like Help Center articles or external content directly to tickets for easy reference. Use this action when you need to: - Attach a Help Center article to a ticket for context - Pin an external knowledge base article to a ticket - Add relevant documentation or resources to a support ticket

Create a custom ticket field in Zendesk with various field types. Use when you need to add a new custom field (such as text, dropdown, checkbox, date, numeric, regex-validated, or lookup) to capture additional information on tickets. The field title is required; description, required flag, and custom options are optional.

Create or update an option for a dropdown or multiselect ticket field. Use when you need to add a new selectable option to a custom ticket field of type 'multiselect' or 'tagger'. If an option with the same value already exists, it will be updated with the provided name. This action is idempotent - running it multiple times with the same value will update the existing option rather than creating duplicates.

Create a ticket in Zendesk via the voice/channel API endpoint. Use this action when you need to create tickets from phone calls, voicemails, or other voice channel interactions. Returns `ticket_id` and `ticket_url` for the created ticket. This endpoint is specifically for Zendesk Talk/voice channel ticket creation.

Create a new trigger in Zendesk. Triggers are business rules that automatically perform actions on tickets when certain conditions are met. Unlike automations, triggers execute immediately when tickets are created or updated. Use this action when you need to: - Automatically change ticket status based on conditions - Assign tickets to agents or groups based on rules - Add tags to tickets matching certain criteria - Send notifications to agents, groups, or external systems - Update custom fields based on ticket properties Note: Triggers must have at least one condition in the 'all' array that references a time-based field (like created_at, updated_at) OR checks one of: status, type, group_id, assignee_id, requester_id, custom_status_id.

Create a batch job for ticket trigger categories in Zendesk. Use this action when you need to perform batch operations on multiple trigger categories at once. The action 'patch' allows updating trigger categories in bulk. Returns job status and results that can be polled for completion. Endpoint: POST /api/v2/trigger_categories/jobs

Create or update an option for a dropdown or multiselect user field. Use when you need to add a new selectable option to a custom user field of type 'multiselect' or 'tagger'. If an option with the same value already exists, it will be updated with the provided name. This action is idempotent - running it multiple times with the same value will update the existing option rather than creating duplicates.

Tool to add an identity to a user's profile in Zendesk. An agent can add multiple identities to a user (e.g., multiple email addresses). Use this when a user needs to be contacted via a new channel or needs an additional identifier. Use when you need to add an additional identity (email, phone, social) to an existing Zendesk user.

Create a new organization membership for a specific user in Zendesk by assigning a user to an organization. Use when you need to associate an existing user with an organization so they can access organization-specific tickets and data. This action targets a specific user by their ID. This action is idempotent in that creating a duplicate membership will fail with a specific error, but the operation itself is not naturally idempotent.

Store an event against a Sunshine user profile. Creates the profile if it doesn't exist. Use when tracking user activities such as purchases, sign-ups, or custom application events. The event is associated with the profile identified by the provided identifiers. This action is useful for building user activity timelines and triggering automations based on profile events.

Set tags on a Zendesk user via POST request to /api/v2/users/{user_id}/tags. Use when you need to add or update tags on a specific user. Note that this replaces all existing tags on the user with the provided set of tags. This action is idempotent.

Create a new view in Zendesk. Views are saved ticket filters that help agents organize and prioritize their work. They can filter tickets by conditions like status, priority, assignee, and more. Use this action when you need to: - Create a custom view for a specific team or workflow - Set up views for different ticket priorities or statuses - Create views with restricted access for specific groups - Configure views with specific columns, grouping, and sort order Note: At minimum, the 'all' conditions must include a condition checking 'status', 'type', 'group_id', 'assignee_id', or 'requester_id'.

Create a new custom object in Zendesk. Use when you need to define a new custom object type to store and manage custom data. The key is immutable once created, so choose carefully.

Create a new field for a custom object in Zendesk. Use when you need to add a new attribute or data field to an existing custom object type. The key is immutable once created. This action is idempotent for the same key, but the key parameter must be unique per custom object.

Create a new dynamic content item with locale variants in Zendesk. Dynamic content items enable localized content for ticket fields, macros, and other text-based content. Use when setting up multilingual support or creating template content that varies by user locale. The item's name cannot be changed after creation. Ensure the name is descriptive and follows your naming conventions.

Create a new locale variant for an existing dynamic content item in Zendesk. Use when you need to add support for a new locale to an existing dynamic content item. Note: You can only create one variant per locale per dynamic content item. Use the update action to modify existing variants.

Create a new group in Zendesk. The group name must be unique within the account. Use when organizing agents into teams for ticket assignment and routing. Returns the full group object including the assigned ID — persist it for subsequent operations.

Create a group membership in Zendesk, assigning an agent to a group. Use when you need to add an agent to a specific group for ticket routing, permissions, or team organization. The user_id and group_id are both required parameters. Note: The user must exist and have appropriate permissions to be assigned to groups. The group must also exist.

Create a new organization in Zendesk. After creation, the organization ID is auto-assigned and returned. Verify the exact ID before performing downstream operations that target this organization. Multiple organizations may share similar names — always confirm the correct organization by ID. This action is irreversible — the organization cannot be recovered once deleted. Use this action when you need to register a new company, customer, or group as a Zendesk organization so you can assign users, tickets, or other resources to it.

Create a new request in Zendesk. Use when an end user needs to submit a support request through the API. The request will be created with the provided subject, description, priority, and other optional fields. Returns the created request with its ID and URL.

Create a target in Zendesk for triggering outbound integrations. Use when you need to set up a notification channel or integration with external services like Campfire, email, URL webhooks, or other supported targets. Targets can be used with triggers and automation rules. Note: URL targets are being discontinued October 28, 2024 in favor of webhooks. Email targets remain unaffected.

Create a ticket in Zendesk with full support for all ticket fields. Returns `ticket_id` and `ticket_url`; use ZENDESK_GET_ZENDESK_TICKET_BY_ID for the full ticket object.

Create a new trigger category in Zendesk. Trigger categories are used to organize and group triggers for better management. Use when setting up automated workflows or organizing business rules. This action creates a trigger category with the specified name and optional position. The name must be unique within the account.

Tool to create a new user in Zendesk. Search for existing users first to avoid duplicate accounts with the same email. Use when you need to onboard a user with specific details.

Create a custom user field in Zendesk. Use when you need to define a new custom field to capture additional user data. Supports text, checkbox, dropdown, multiselect, date, integer, decimal, regexp validation, and lookup types. Only administrators can create user fields.

Delete an access rule for a custom object in Zendesk. This action is irreversible — the access rule cannot be recovered once deleted. Use when you need to remove access control rules for custom objects.

Bulk delete all sessions for a specific user in Zendesk. This action invalidates all active sessions for the specified user, forcing them to re-authenticate on their next API call or login. Use when you need to forcibly log out a user by revoking all their active sessions, such as during security incidents or account deactivation. This action is irreversible — all sessions for the user will be immediately invalidated and cannot be recovered.

Delete the current authenticated session in Zendesk. This action invalidates the current API session, requiring re-authentication for future API calls. Use when you need to explicitly log out the current user session or terminate an active authenticated connection. This action is irreversible — the session cannot be recovered once deleted. Note: This action targets the authenticated user's own session only and cannot terminate other user sessions.

Permanently deletes a custom object record in Zendesk by its external ID or name. Use this action when you need to remove a specific record from a custom object. This action is irreversible — the record cannot be recovered once deleted. Requires admin permissions. Note: Either external_id or name must be provided to identify the record to delete.

Permanently deletes an attachment from a custom object record in Zendesk. Use this action when you need to remove a specific file attachment from a custom object record. This action is irreversible — the attachment will be permanently deleted and cannot be recovered once removed. Note: Only attachments that are not required and not the primary attachment can be deleted.

Permanently deletes a soft-deleted ticket from Zendesk. This action is irreversible - once a ticket is permanently deleted, it cannot be recovered. Use this action to remove tickets that were previously soft-deleted using the delete_ticket action. Use this action when you need to permanently remove a ticket that has already been deleted and is no longer accessible through normal operations.

Permanently removes a user from an organization in Zendesk by deleting the organization membership. This action is irreversible — the membership cannot be recovered once deleted. Use this action when you need to remove a user's association with an organization. This operation requires admin permissions.

Remove all tags from a Zendesk organization. Use when you need to clear organization tags as part of cleanup or reorganization tasks. This action is irreversible — the tags will be permanently removed from the organization and cannot be recovered once deleted.

Delete a resource collection in Zendesk. Use when you need to remove a resource collection that is no longer needed. This action returns a job status that can be polled to track the deletion progress. This operation is irreversible; confirm the correct resource_collection_id before executing.

Permanently deletes an option from a ticket field in Zendesk. Use this action when you need to remove a specific selectable option from a dropdown or multiselect ticket field. This action is irreversible — the ticket field option will be permanently deleted and cannot be recovered once removed. Note: Only custom options can be deleted. System-defined options cannot be removed.

Remove tags from a Zendesk ticket. This action is irreversible; once tags are removed, they cannot be recovered without re-adding them. Use when you need to clean up ticket tags, remove outdated labels, or clear all tags from a ticket.

Permanently deletes an option from a user field in Zendesk. Use this action when you need to remove a specific selectable option from a dropdown or multiselect user field. This action is irreversible — the user field option will be permanently deleted and cannot be recovered once removed.

Deletes an identity for a given user in Zendesk. Use when you need to remove a specific identity (e.g., email, phone, social login) from a user's account. This action is irreversible — once the identity is deleted, it cannot be recovered. Ensure you have the correct user_id and user_identity_id before executing.

Remove tags from a Zendesk user. Use when you need to clean up user tags, remove outdated labels, or clear all tags from a user account. This action is irreversible — once tags are removed, they cannot be recovered without re-adding them.

Permanently removes a user from an organization in Zendesk by deleting the organization membership for a specific user. This action is irreversible — the membership cannot be recovered once deleted. Use this action when you need to remove a user's association with an organization for a specific user. This operation requires admin permissions.

Permanently removes an installed app from Zendesk. Use when you need to uninstall an app from your Zendesk instance. This action is irreversible — the app installation cannot be recovered once removed. Admin permissions are required.

Permanently deletes an automation in Zendesk. This action is irreversible — the automation will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete automations or removing test data. Note: You might be restricted from deleting automations that are active or referenced by other rules.

Permanently deletes a bookmark in Zendesk. Use when you need to remove a user bookmark. This action is irreversible — the bookmark cannot be recovered once deleted.

Permanently deletes a business hours schedule in Zendesk. Use when you need to remove obsolete schedules or clean up test data. This action is irreversible — the schedule cannot be recovered once removed. Admin permissions are required. Note: Schedules that are currently in use by active SLA policies or other configurations may not be deletable.

Permanently deletes a custom object definition in Zendesk. Use this action when you need to remove a custom object type and all its associated records. This action is irreversible — the custom object and all its data will be permanently deleted and cannot be recovered once removed. Requires admin permissions. Note: Deleting a custom object will also delete all records associated with it.

Permanently deletes a custom object field in Zendesk. Use this action when you need to remove a specific field from a custom object definition. This action is irreversible — the field and all its data will be permanently deleted and cannot be recovered once removed. Requires admin permissions.

Permanently deletes a custom object record in Zendesk. Use this action when you need to remove a specific record from a custom object type. This action is irreversible — the record and its data will be permanently deleted and cannot be recovered once removed. Requires the custom object key and the record ID to identify which specific record to delete.

Permanently deletes a custom object trigger in Zendesk. Use this action when you need to remove a specific trigger from a custom object definition. This action is irreversible — the trigger and all its data will be permanently deleted and cannot be recovered once removed. Requires admin permissions.

Permanently deletes a custom ticket status in Zendesk. Use this action when you need to remove a custom ticket status from the system. This action is irreversible — the custom status will be permanently deleted and cannot be recovered once removed. Note: Ensure no tickets are using this custom status before deletion.

Permanently deletes a deletion schedule in Zendesk. This action is irreversible — the deletion schedule will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete deletion schedules or removing test data.

Permanently deletes a dynamic content item in Zendesk. This action is irreversible — the dynamic content item cannot be recovered once deleted. Always confirm the correct dynamic_content_item_id before executing.

Permanently deletes a dynamic content item variant in Zendesk. This action is irreversible — the variant cannot be recovered once deleted. Always confirm the correct dynamic_content_item_id and dynamic_content_variant_id before executing.

Permanently deletes a group membership in Zendesk, immediately removing a user from a group. This action is irreversible — the group membership cannot be recovered once deleted. Use when cleaning up obsolete group memberships or removing users from groups. Note: Deleting a group membership does not delete the user or the group itself, only the association between them.

Permanently deletes a macro in Zendesk. This action is irreversible — the macro will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete macros or removing test data. Note: You might be restricted from deleting macros that are active or referenced by other rules.

Delete an organization in Zendesk. This operation is irreversible; confirm organization_id and get explicit user confirmation before calling.

Permanently deletes an organization field in Zendesk. Use this action when you need to remove a custom organization field from the system. This action is irreversible — the organization field will be permanently deleted and cannot be recovered once removed. Any data stored in this field across all organizations will be lost. Note: Ensure no organizations are using this field before deletion, as the deletion cannot be undone.

Permanently deletes an organization subscription in Zendesk. This action is irreversible — the subscription cannot be recovered once removed. Use when you need to remove an organization subscription.

Permanently deletes a support address from Zendesk. This action is irreversible — the support address cannot be recovered once deleted. Use this action when you need to remove a deprecated or unwanted support email address from your Zendesk account. This operation requires admin permissions and the support address must not be set as the default address. Deleting an address that is actively used may impact email routing.

Permanently deletes a target in Zendesk. This action is irreversible — the target will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete targets or removing test data. Note: Deleting a target that is actively used by triggers or other automation rules may cause those rules to fail.

Permanently deletes a ticket in Zendesk, including its entire conversation history. This action is irreversible; always confirm the correct ticket_id before executing.

Permanently deletes a ticket field in Zendesk. Use this action when you need to remove a custom ticket field that is no longer needed. This action is irreversible — the ticket field and all associated data will be permanently deleted and cannot be recovered once removed. Requires admin permissions. Note: System ticket fields cannot be deleted. Only custom ticket fields can be removed.

Permanently deletes a trigger in Zendesk. This action is irreversible — the trigger will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete triggers or removing test data. Note: You might be restricted from deleting triggers that are active or referenced by other rules.

Permanently deletes a trigger category in Zendesk. This action is irreversible — the trigger category will be permanently deleted and cannot be recovered once removed. Use when cleaning up obsolete trigger categories or removing test data. Note: You might be restricted from deleting trigger categories that are in use by active triggers.

Tool to permanently delete a user from Zendesk. Use when you need to remove a user account. This action cannot be undone and requires appropriate admin permissions.

Permanently deletes a user field in Zendesk, removing it from all user profiles. This action is irreversible — the field and all its associated data will be permanently lost. Use when cleaning up deprecated custom fields or removing test fields.

Permanently deletes a user profile in Zendesk by its profile ID. This action is irreversible — the profile and all associated data will be permanently lost. Use when cleaning up duplicate profiles, test profiles, or removing profiles that are no longer needed. Requires agent-level access with appropriate role permissions.

Delete a specific user session in Zendesk. Use this action when you need to invalidate and remove a specific user session. This action is irreversible — the session cannot be recovered once deleted. Use when you need to forcibly log out a user or remove a specific session from their account for security or administrative purposes.

Permanently deletes a user's group membership in Zendesk, immediately removing a user from a group. This action is irreversible — the group membership cannot be recovered once deleted. Use when cleaning up obsolete group memberships, removing users from groups, or revoking group access. Note: Deleting a group membership does not delete the user or the group itself, only the association between them. The user will no longer have access to tickets routed to that group.

Delete a single view in Zendesk. This action is irreversible — the view will be permanently deleted and cannot be recovered once removed. Use when you need to remove a specific obsolete view or test view. Returns 204 No Content on success.

Detect the best language/locale for the current user based on their browser settings and account preferences. Use when you need to determine the optimal language to display content in for a user, such as when localizing ticket comments, article content, or Help Center pages. This action reads the user's preferred languages from the Accept-Language header and matches them against supported locales in your Zendesk account. The detected locale is returned with full locale details including ID, name, and API URL.

Download attachment file from a Zendesk custom object record. Use when you need to retrieve the actual file content of an attachment associated with a custom object record, such as documents, images, or other files. This action returns the raw file content and can display it inline or trigger a file download depending on the inline parameter. Note: The custom object must have attachments enabled for this action to work.

Execute a Zendesk view to retrieve its column titles and matching ticket rows. Use when you need to run a saved view and get its results - useful for checking which tickets match a view's conditions without manually applying filters. Supports pagination, custom sorting, and optional grouping of results. Returns the view's execution metadata alongside the matching rows.

Export incremental routing instance values from Zendesk skill-based routing. Returns a stream of changes that occurred on routing attributes, attribute values, and instance values. Use this action when you need to synchronize routing configuration data or monitor changes to skill-based routing assignments. This action is read-only and supports cursor-based pagination with a maximum of 3000 records per page. Stop paging when the count is 0. Note: The cursor parameter is read-only and should only be obtained from API responses, not manually constructed.

Export search results from Zendesk using cursor-based pagination. Use when you need to export large sets of search results (tickets, users, organizations, groups) and process them in batches using cursor pagination. This action differs from the regular search endpoint by supporting cursor-based pagination instead of offset pagination, making it more efficient for large datasets. The 'page_after' parameter in responses contains the cursor token for fetching subsequent pages.

Export Suspended Tickets from Zendesk Support. Use when you need to export all suspended tickets for compliance review, audit purposes, or data analysis. This action enqueues a job that creates a CSV file; when complete, Zendesk emails the requester a link to download the CSV. Suspended tickets are sorted by update timestamp in ascending order. Rate limited to one request per minute. Note: This action is read-only and returns the export job status. The actual CSV will be sent via email when the job completes.

Export a Zendesk view as a CSV file. Use when you need to download view data for offline analysis, reporting, or data migration purposes. The export contains all tickets matching the view's filter criteria and columns. Note that if the export is not immediately available, Zendesk may return a status indicating the job is queued - retry after a short delay in such cases. Note: This action downloads file content and may take longer for views with large datasets.

Retrieve Zendesk account settings. Use this action when you need to view the configuration and feature flags for a Zendesk account, including API settings, branding, ticket preferences, chat configuration, voice settings, and more.

Retrieve attribute values for multiple agents/users using the Skill-Based Routing API. Use when you need to get the routing attribute values (such as skills, languages, or other qualifications) assigned to specific agents. This action is read-only and idempotent. Note: This action returns only the attribute values directly assigned to the agents. It does not include inherited or group-based attributes.

Get a single Zendesk app by its numeric ID. Use when you have an app ID and need to retrieve the app's details including name, author information, version, installation count, categories, and description.

List all requirements for a Zendesk app installation. Use when you need to check what configuration or parameters are required for a specific installed app to function properly. Requirements may include OAuth settings, parameter configurations, or other setup steps needed by the app. This action is read-only and idempotent.

Get details for a specific Zendesk app location by its numeric ID. Returns location properties including visibility settings, orderability, and associated product codes. Use when you have an app_location_id from listing locations or creating apps and need to retrieve detailed location information. Only accessible to admin users.

Retrieves the public key for a specific Zendesk app. The response is in JSON Web Key (JWK) format containing RSA key components (modulus n, exponent e). Use this action when you need to verify JWTs issued by a Zendesk app or establish trust for app-based authentication. This is a read-only operation.

Retrieves the public key for a specific Zendesk app in PEM format. The PEM format is a standard base64-encoded certificate format that can be used to verify that requests from the app are legitimate. Use this action when you need to verify JWTs issued by a Zendesk app or establish trust for app-based authentication. This is a read-only operation. Note: This endpoint does not require authentication and can be accessed anonymously.

Search for Zendesk tags using autocomplete. Use when you need to find tag suggestions based on a partial tag name for tagging tickets or organizing content.

Show the current locale for a Zendesk account. Use when you need to determine what language/locale is currently active for the account, which affects how content is displayed to end users and which translations are available.

Show the currently authenticated session in Zendesk. Returns details about the active session including authentication time, last seen time, and user ID. Use when you need to verify the current session status or retrieve session metadata for the authenticated user.

Get the settings for the currently authenticated user in Zendesk. Returns user preferences including Admin Center UI settings, Lotus UI settings (onboarding, tooltips, keyboard shortcuts), and shared views order. Use this action to retrieve the current user's personal settings and preferences.

Get the current count and maximum limit for custom object fields in Zendesk. Returns the number of fields currently defined for a specific custom object and the maximum allowed limit. Use when you need to check how many fields have been created for a custom object and how much capacity remains before hitting the limit. This is a read-only operation that does not modify any data.

Get the current record limit and usage count for custom objects in Zendesk. Returns the current number of custom object records and the maximum allowed limit. Use when you need to check how many custom object records have been created and how much capacity remains. This is a read-only operation that does not modify any data.

Get the current count and maximum limit for custom objects in Zendesk. Use when you need to check how many custom objects exist in your Zendesk account and what the allowed limit is, to avoid exceeding capacity or to plan for scaling.

Get a specific custom ticket status from Zendesk by its ID. Use when you have a custom status ID from ticket payloads or from listing custom statuses and need to retrieve the full status details including agent/end-user labels, descriptions, and status category. This is a read-only, idempotent operation that retrieves the current state of a custom ticket status.

Retrieves a single deleted Zendesk user by their ID. Use when you have a specific deleted user ID and need to fetch details about that deleted user, such as for auditing purposes, account recovery, or compliance records. Deleted users retain their associated tickets and historical data.

Retrieve a specific deletion schedule from Zendesk by its ID. Use this action when you need to get the details of a particular deletion schedule, including its title, description, active status, object type, conditions, and creation/update timestamps. This action is read-only and idempotent.

Retrieve details of a single email notification in Zendesk by its notification ID. Use when you have a notification_id from ticket audit logs or email notifications list and need to fetch full notification details including recipients, delivery status, and associated ticket/comment information. This action is useful for tracking email delivery status and troubleshooting email notification issues.

List email notifications from Zendesk. Use this action when you need to retrieve email notification records filtered by ticket, comment, or notification ID. The filter parameter is required to specify which type of ID to filter by. Returns delivery status information for each recipient including any delivery failures.

Tool to fetch a specific end user identity by user ID and identity ID. Use when you need to retrieve detailed information about a particular user identity in Zendesk.

Tool to retrieve full entitlements for a Zendesk user across all products (Chat, Explore, Talk, Guide). Use when you need to check which Zendesk products a user has access to and their activation status. Returns detailed entitlement information including whether each product is active and its display name.

Get a group membership by its unique ID. Use when you have a group membership ID and need to retrieve details including the associated group, user, and timestamps. Note: The group_membership_id parameter is the membership ID, not a group ID.

Retrieve organizations that have been modified since a specified start time using the Incremental Organization Export API. Use when you need to sync or track changes to Zendesk organizations over time. Provide a start_time (Unix timestamp) from a previous response's end_time to paginate through changes incrementally. This action is read-only and idempotent. Organizations may be created, updated, or appear as deleted; interpret based on your use case. Rate limiting may apply for large accounts.

Retrieve routing attribute values that have been modified since a specified start time using the Incremental Skill-Based Routing API. Use when you need to sync or track changes to routing attributes, values, and their associations over time. Provide a start_time (Unix timestamp) and the API returns all attribute values modified since that time. Call repeatedly with the end_time from each response to paginate through all changes. This action is read-only and idempotent. Note: Data isn't available for the most recent minute due to eventual consistency. Attribute values may appear as modified; interpret based on your use case.

Test the incremental export by retrieving a sample of records that have changed since a specified start time. Use this action to verify your incremental export setup before running full exports. Use when you need to test the incremental export functionality for a specific resource type (e.g., tickets, users, organizations). The sample export returns a limited set of records that can help you validate data retrieval before implementing full sync operations. Note that data isn't provided for the most recent minute, and the start_time must be at least one minute in the past.

Export incremental ticket events from Zendesk. Use when you need to track changes to tickets over time, monitor agent performance metrics, or sync ticket event data with an external system. This action returns a stream of ticket metric events (like agent work time, reply times) that occurred after the specified start_time. Call repeatedly with the end_time from each response to continue exporting events. Data isn't available for the most recent minute due to eventual consistency. Note: This is a read-only, idempotent operation. The start_time must be at least one minute in the past.

Retrieve tickets that have been modified since a specified start time using the Incremental Ticket Export API. Use when you need to sync or track changes to Zendesk tickets over time, build audit trails, or implement incremental backups. Provide a start_time (Unix timestamp) from a previous response's end_time to paginate through changes incrementally. This action is read-only and idempotent. Tickets may be created, updated, or appear as changed; interpret based on your use case. Rate limiting may apply for large accounts. Note: Data isn't provided for the most recent minute.

Export tickets incrementally using cursor-based pagination. Use this action when you need to retrieve all changes to tickets since a specific time, with support for large result sets through cursor-based pagination. The start_time parameter is required for the initial request; subsequent pages use the cursor returned in previous responses. Use when you need to sync ticket data from Zendesk, maintaining a real-time or near-real-time copy of ticket information. This is ideal for data synchronization, backup systems, or analytics pipelines that need to process all ticket changes over time. The action automatically handles pagination by providing cursor tokens in the response.

Retrieve users that have been modified since a specified start time using the Incremental User Export API. Use when you need to sync or track changes to Zendesk users over time, such as for data warehousing, backup, or external system synchronization. Provide a start_time (Unix timestamp) and the API returns users that have been created, updated, or deleted since that time. Call repeatedly with the end_time from each response to paginate through all changes. This action is read-only and idempotent. Note: Data isn't available for the most recent minute due to eventual consistency. Users may appear as modified or deleted; interpret based on your use case.

Get a single job status by ID from Zendesk. Shows the status of a background job initiated by bulk operations (like bulk updates, imports, or exports). The response includes progress information, completion status, and any results from individual tasks. Use this action when you have a job_status_id from a previously queued bulk operation and need to check if it completed successfully, failed, or is still processing. Check the 'status' field for the current state ('queued', 'working', 'completed', 'failed') and the 'results' array for individual task outcomes.

Get a locale by its ID or BCP-47 code. Use when you need to retrieve details about a specific locale including the locale identifier, language name, and timestamps.

Get details for a specific organization field in Zendesk by its ID or key. Use this action when you need to retrieve detailed information about a single custom organization field, including its type, options, validation rules, and display settings. This is useful for understanding field configuration or before updating/deleting a field. Returns the complete organization field definition with all metadata.

Get details for a specific organization membership by its ID. Use when you have an organization membership ID and need to retrieve the associated user, organization, and membership metadata. This action is read-only and idempotent - calling it multiple times with the same membership ID will return the same result.

Get related counts and information for a specific Zendesk organization by ID. Returns metadata about tickets, users, groups, activities, and other related resources associated with the organization. Use when you need to understand the scale and composition of an organization's resources in Zendesk. This is a read-only, idempotent operation.

Show Organization Subscription - retrieves details of a specific organization subscription by its ID. Use when you need to get information about an organization subscription, including the associated user and organization IDs, and the creation timestamp. This is a read-only operation that does not modify any data.

List all tags associated with a specific Zendesk organization. Use when you need to retrieve the tags assigned to a particular organization for ticket categorization, filtering, or reporting purposes.

Get tickets for a specific organization in Zendesk. Returns tickets where organization_id matches the specified organization. Use when you need to retrieve all tickets associated with a particular organization, such as for reporting or review purposes. Pagination is available for large result sets; follow next_page links until null to retrieve all tickets. Note: This endpoint returns organization tickets that may include tickets from multiple requesters within the organization.

List apps owned by the current Zendesk account. Use when you need to retrieve information about apps installed in your Zendesk instance, such as checking installed apps, reviewing app details (version, status, author), or auditing your app inventory. This endpoint requires admin authentication.

List recently viewed tickets in Zendesk. Returns tickets sorted by the time they were last viewed, most recent first. Useful for agents to quickly access tickets they've been working on. The endpoint returns tickets visible to the agent based on their permission restrictions. Pagination is limited to 10,000 records (100 pages * 100 per page). Use this action to retrieve the tickets an agent has recently accessed in the Zendesk interface.

Get a specific comment from a Zendesk request. Use when you need to retrieve a single comment by its ID for a given request, such as displaying a specific comment detail or checking comment metadata. This action is read-only and idempotent.

Count the number of items matching a search query in Zendesk. Use when you need to know how many results a search would return without fetching all the actual results. This is useful for displaying result counts before executing a full search.

Show Security Settings for a Zendesk account. Use when you need to retrieve the security configuration of a Zendesk account, including session timeouts, password policies, two-factor authentication settings, IP restrictions, and account assumption options. This is a read-only, idempotent operation that does not modify any data. This action is useful for auditing security settings, verifying compliance requirements, or understanding the security posture of a Zendesk account.

Get a specific side conversation by its ID for a Zendesk ticket. Side conversations are private agent-to-agent communications that don't notify the customer. Use this action when you need to retrieve details about a specific side conversation on a ticket, such as its current state, participants, or message history. If the side conversation is a child ticket, the external_ids object's targetTicketId property contains the child ticket's ID.

Get a support address by its unique ID. Use when you have a support_address_id and need to retrieve details including the email address, brand association, and DNS verification statuses. This is a read-only operation.

Show a specific audit for a ticket from Zendesk. Returns a single audit record containing events that describe changes made to the ticket. Each audit captures a specific action such as comments, status changes, assignments, or field updates. Use this action when you have a specific audit ID and want to retrieve detailed information about that audit event. Use this action when you need to retrieve detailed information about a specific audit record for a ticket, including all events and metadata associated with that audit.

List comments on a Zendesk ticket. Returns the comments added to the ticket in chronological order (oldest first by default). Each comment has both `html_body` and `plain_body` fields — use `plain_body` for clean text without HTML. Public comments are visible to end users while internal comments are only visible to agents. Use the `include_inline_images` parameter to include inline images as attachments. For bulk operations, honor `Retry-After` headers on HTTP 429 rate limit responses.

List conversation log events for a specific Zendesk ticket. Use this action when you need to retrieve the chronological history of interactions, comments, and activities on a ticket. The conversation log provides a comprehensive view of all events including comments, status changes, and other ticket activities. Supports cursor-based pagination for accessing large datasets.

Retrieve a specific ticket metric from Zendesk by its ID. Use this action when you have a ticket_metric_id and need to fetch the detailed metrics for that ticket, including resolution times, wait times, reply times, and SLA breaches. This action is read-only and idempotent — fetching the same metric multiple times has no side effects.

List Ticket Metrics from Zendesk. Returns a list of tickets with their associated metrics including response times, resolution times, and assignment statistics. Use when analyzing ticket performance, agent productivity, or customer satisfaction metrics. This action supports cursor-based pagination via page_size, page_after, and page_before parameters for efficient traversal of large datasets.

Get ticket metrics from Zendesk for a specific ticket. Returns performance metrics including resolution times, agent and requester wait times, reply counts, station changes, and timestamps for key events. Use when you need to analyze ticket performance, SLA compliance, or agent productivity metrics.

List all tags associated with a specific Zendesk ticket. Use when you need to retrieve the tags assigned to a particular ticket for categorization, filtering, or reporting purposes.

Get Ticket Trigger Action and Condition Definitions. Use when you need to discover the available actions and conditions that can be used to create or configure ticket triggers. This returns metadata about what types of automations are possible - the action definitions show what a trigger can do (e.g., set status to 'solved'), while the condition definitions show what conditions can trigger it (e.g., when status is 'open'). This is a read-only, idempotent operation that returns the available trigger definitions metadata.

Tool to fetch GDPR compliance deletion statuses for a specific Zendesk user. Use when you need to check the deletion status for each compliance area (e.g., chat, talk) associated with a user account. Returns status records showing deletion requests and their current state. Use when auditing user data deletion requests, verifying GDPR compliance status, or tracking the progress of data removal across different Zendesk products.

Retrieve event history for a specific Zendesk user. Use when you need to track user activity such as login history, profile changes, or other interactions with the Zendesk system. Supports filtering by event source, type, and time range. This action is read-only and idempotent. Note: The 'zendesk' source value is protected; attempts to use it when creating events result in an error.

Retrieve a single Zendesk user field by its numeric ID. Use when you have a user field ID and need to fetch its full definition including title, type, description, custom options, validation patterns, and other settings. This is a read-only, idempotent operation.

Retrieve multiple Zendesk user fields by their keys. Use when you have specific user field keys and need to fetch their definitions (title, type, description, options, etc.) in a single request instead of making individual calls. This is a read-only, idempotent operation.

Get password requirements for a specific Zendesk user. Use when you need to retrieve the password policy rules that apply to a user's password, such as minimum length, complexity requirements, or expiration policies. This action is read-only and idempotent.

Retrieve a single Zendesk user profile by its Sunshine profile ID. Use this action when you have a specific profile_id (obtained from profile listings or search results) and need to fetch the full profile details including attributes, identifiers, and linked user information. Note that this uses the Sunshine Profiles API with string profile IDs, not numeric user IDs from the Users API.

Get events for a Sunshine profile by its profile ID. Use when you have a specific Sunshine profile ID (obtained from profile lookup or creation) and need to retrieve all events associated with that profile. This action is read-only and idempotent — use it to track profile activity, audit event history, or monitor user interactions for a specific profile. Note: The profile must exist or the request returns 404 Not Found. Use this action after creating or looking up a Sunshine profile to retrieve its event history.

Get related counts and information for a specific Zendesk user by ID. Returns metadata about assigned tickets, CC'd tickets, organization subscriptions, and requested tickets associated with the user. Use when you need to understand the scale and composition of a user's ticket activity and subscriptions in Zendesk. This is a read-only, idempotent operation.

List all tags assigned to a specific Zendesk user. Use when you need to see what tags are associated with a particular user for organizing, filtering, or categorizing user data. This action is read-only and idempotent.

Get a specific group membership for a user by their IDs. Use when you have both a user ID and a group membership ID and need to retrieve details including the associated group, user, and timestamps. This action retrieves a single group membership record scoped to a specific user, unlike GetGroupMembership which retrieves by membership ID alone, and unlike ListUsersGroupMemberships which lists all memberships for a user.

Get details for a specific organization membership by user ID and membership ID. Use when you have both a user ID and an organization membership ID and need to retrieve the associated membership metadata including organization details, default status, and ticket viewing permissions. This action is read-only and idempotent - calling it multiple times with the same parameters will return the same result.

Returns an approximate count of organizations that a user belongs to. Use when you need to know how many organizations a specific user is associated with in Zendesk.

Retrieve profiles associated with a specific Zendesk user by user ID. Use when you need to look up user profile information using the Zendesk user ID. This action returns all profiles linked to the specified user account. This action is read-only and idempotent. Note: Access requires agent permissions in Zendesk (Support > People > Roles > People).

Get information about the currently authenticated user in Zendesk. Returns only the caller's own account; to look up other users, use ZENDESK_SEARCH_ZENDESK_USERS. Response nests the user object under data.owner_info.user. Useful for verifying the acting user's identity and permissions before performing bulk operations.

Show a Brand. Use when you have a brand ID and need to retrieve detailed information about a specific Zendesk brand, including its name, subdomain, active status, Help Center configuration, logo, and associated ticket forms.

Get metadata for a specific Zendesk organization by ID. Response fields are available under data.organization_info. Does not return member/user lists.

Retrieve the details of a specific organization merge operation in Zendesk. This action shows the merge status and the organizations involved. Use when you need to check the status of an organization merge or view details of a past merge operation. This is a read-only, idempotent operation.

Get all organizations in Zendesk. Returns results nested under an 'organizations' array; an empty list is valid. Accepts no server-side filters — all filtering by name, domain_names (an array field), or organization_fields must be done client-side. Large accounts require pagination; missing pages will undercount results. Multiple organizations may share similar names or domains — always disambiguate using external_id or domain_names and confirm organization_id before acting. Avoid repeated full-list fetches on large accounts; cache or batch client-side instead.

Get ticket details from Zendesk. Response wraps all data under a top-level `data` key; access `data

Get details for a specific ticket form in Zendesk by its ID. Returns the complete ticket form object including its name, display settings, visibility conditions, associated ticket fields, and brand restrictions. Use when you need to retrieve detailed information about a particular ticket form configuration. This is a read-only, idempotent operation that does not modify any data.

Get related information for a specific Zendesk ticket. This endpoint returns data about tickets that are related to the specified ticket, including follow-up sources, associated Jira issues, and incident counts. Use this action when you need to understand the relationships and connections between tickets in Zendesk.

Import a ticket into Zendesk with historical timestamps. This action creates tickets with past `created_at`, `updated_at`, or `solved_at` values, useful for migrating historical data. For real-time ticket creation, use ZENDESK_CREATE_ZENDESK_TICKET. Tickets created with 'closed' status and archive_immediately=true bypass normal lifecycle and go directly to archive.

Export routing attributes incrementally with optional start_time filtering and cursor-based pagination. Use when you need to retrieve all skill-based routing attributes (attributes, attribute values, and instance values) that have changed in your Zendesk account. This is a read-only operation that returns a stream of changes; it does not include data from the most recent minute. For large datasets, use cursor-based pagination with the after_cursor value from responses. This action is read-only and idempotent — calling it multiple times with the same start_time returns the same results.

Export users incrementally using cursor-based pagination. Use when you need to export all users from Zendesk in a reliable, paginated manner. The start_time parameter is required for the initial request to define the time range. Subsequent requests use the cursor returned in previous responses to fetch the next batch of records. This action is ideal for: - Full user data synchronization to external systems - Regular incremental backups of user data - Building user directories with pagination support Note: Data from the most recent minute is not included to ensure consistency.

Install a Zendesk app in the account. Use when you need to add an app from the Zendesk marketplace or a private app to your Zendesk instance. You must provide the app_id and settings. This action is irreversible once installed.

List all access rules for a Zendesk custom object. Access rules control which users and roles can perform specific operations on custom object records. Use this action when you need to audit existing permissions or understand what access controls are in place for a custom object type. This is a read-only operation.

List all active automations in Zendesk. Use when you need to retrieve the currently active automation rules that automatically perform actions based on ticket conditions. This action returns all automations marked as active, including their conditions and actions. Note: This only returns active automations; to see all automations including inactive ones, you would need a different action.

List all active shared and personal macros in Zendesk. Use when you need to retrieve, audit, or review the macros configured in your Zendesk account. Macros are saved responses that agents can apply to tickets. This action supports filtering by access level, category, group, and sorting options. Note: This action only returns active macros. The sort_by parameter supports sorting by usage metrics (usage_1h, usage_24h, usage_7d, usage_30d) to identify the most frequently used macros.

List all active ticket triggers in Zendesk. Use when you need to retrieve the currently active trigger rules that automatically perform actions on tickets when certain conditions are met. This action returns all triggers marked as active, including their conditions, actions, and metadata. Active triggers are business rules that define what happens when ticket conditions are satisfied. This is useful for auditing active automation rules, understanding automated workflows, or finding specific trigger configurations.

List all active shared and personal views available in Zendesk. Use when you need to retrieve, audit, or present the view configuration in your Zendesk account. Views define how tickets are filtered, grouped, and displayed to agents. Supports filtering by access type (personal, shared, account), group membership, and sorting preferences.

List ticket activities in the last 30 days affecting your Zendesk. Activities include actions like ticket assignments, status changes, comments, and more. This action is read-only and idempotent — use it to monitor ticket activity or build activity feeds.

List the translation locales that have been localized for agent use. Use when you need to discover which locales are available for agents to work with in multilingual support scenarios. This is a read-only, idempotent operation that requires no parameters.

List agents assigned to a specific brand in Zendesk. Use when you need to enumerate which agents have access to a specific brand, such as auditing brand access permissions or determining which agents can access a brand's help center. This is a read-only, idempotent operation.

Lists all ticket skips in Zendesk. A skip is a ticket that was skipped during routing or assignment. Use this action to retrieve information about all tickets that have been skipped. This action is read-only and idempotent. Note that archived tickets are not included in the results.

List all app installations in the Zendesk account. The 'enabled' property indicates whether each installed app is active in the product. Use the 'include' parameter to sideload app object details for each installation.

List all available locations where Zendesk apps can be installed. Use when you need to discover valid placement options for installing or configuring Zendesk apps. This endpoint requires admin authentication. All returned locations are read-only.

List all apps location installations from Zendesk. Returns an array of app installation IDs organized by location name. Use when you need to retrieve information about apps installed in specific locations within Zendesk, such as nav_bar or other supported locations. This action is read-only and idempotent. Allowed for: Admins only.

List assignable group memberships in Zendesk. Use when you need to retrieve the group memberships that agents can be assigned to, typically for understanding agent-group assignments or building assignment interfaces. This action is read-only and idempotent. Returns a maximum of 100 group memberships per page.

List all groups that can be assigned to tickets or users in your Zendesk account. Use when you need to enumerate available groups for assignment operations, check group availability, or retrieve group metadata. This is a read-only, idempotent operation.

List assignable group memberships for a specific group in Zendesk. Use when you need to retrieve which agents can be assigned to a particular group, typically for building assignment interfaces or auditing group membership capabilities. This action is read-only and idempotent. Returns a maximum of 100 group memberships per page. Note: This action differs from ListAssignableGroupMemberships by filtering to a specific group rather than returning all assignable memberships.

List all automations for the current Zendesk account. Use when you need to retrieve, audit, or review the automation rules configured in your Zendesk account. Automations are business rules that automatically perform actions based on trigger conditions. Supports both traditional offset pagination and cursor-based pagination. Filter by active status to show only enabled or disabled automations.

List Bookmarks returns all bookmarks created by the user. Use when you need to retrieve all bookmarks to find saved tickets or manage bookmarked items. Archived tickets are not included in the response. _tags =

List brand agent memberships to retrieve which agents are associated with which brands in Zendesk. Use this action when you need to enumerate the brand-agent relationships in a Zendesk account, such as determining which agents can access specific brands or auditing brand access permissions. This is a read-only, idempotent operation.

List brand agent memberships for a specific user in Zendesk. Use when you have a user ID and need to find all brands that the user is an agent for, such as auditing which brands a specific agent can access. This is a read-only, idempotent operation.

List all brands configured in your Zendesk account. Use when you need to enumerate available brands, check which brand is set as default, or retrieve brand metadata like subdomain and host mappings. This is a read-only, idempotent operation that supports both cursor and offset pagination.

List CCD Requests. Use when you need to retrieve requests where the authenticated end user is listed as a CC (carbon copy) recipient. These are requests the user is watching but did not create. Supports sorting by creation or update timestamps.

List all fields for a custom object in Zendesk. Use this action when you need to discover the structure of a custom object, understand what fields are available, or retrieve metadata about custom object fields for further operations like creating or updating records.

List all file attachments for a specific custom object record in Zendesk. Use this action when you need to retrieve the attachments associated with a particular custom object record, for example to display files, verify uploads, or manage attachments for a record. This is a read-only operation that retrieves attachment metadata without downloading file content.

List all records for a specific custom object type in Zendesk. Use this action when you need to retrieve all instances of a custom object (e.g., all car records, all product records) with optional filtering by ID, external ID, sorting, and pagination support. This is a read-only, idempotent operation that returns records with their custom field values. Note: When using pagination (page

List all custom object definitions in Zendesk. Use this action when you need to discover available custom object types, understand their structure, or retrieve metadata about custom objects for further operations. Returns metadata including keys, titles, and configuration options for each custom object.

List all custom roles configured in your Zendesk account. Use when you need to discover available roles, review role configurations, or understand permission structures for your agents. Returns metadata including role names, descriptions, role types, and permission configurations. This is a read-only, idempotent operation with no required parameters.

List custom ticket statuses available in a Zendesk account. Use when you need to retrieve all undeleted custom ticket statuses, optionally filtered by status category, active state, or default status. This action is useful for understanding available custom statuses for ticket workflows, automation rules, or displaying status options to users.

Lists tickets that have been deleted from Zendesk, showing up to 100 deleted tickets per page with pagination. Use when you need to retrieve information about previously deleted tickets or audit ticket deletions. This action is read-only and idempotent.

Tool to list deleted users in Zendesk via the Users API. Use when you need to retrieve information about users that have been deleted from the system. This is a read-only operation.

List all deletion schedules for the current Zendesk account. Use when you need to retrieve, audit, or review the deletion schedule rules configured in your Zendesk account. Deletion schedules define automated data retention policies that periodically remove specified entity types based on configured conditions. Only Zendesk admins can access this endpoint.

List all dynamic content items configured in your Zendesk account. Use when you need to enumerate available dynamic content items, check variants for localization, or retrieve metadata about placeholder values for dynamic content. This is a read-only, idempotent operation that supports both cursor and offset pagination.

List all variants of a specific Zendesk dynamic content item. Use when you need to retrieve all locale variants for a dynamic content item to view, manage, or update the localized content. Variants represent the same content in different locales/languages. Supports pagination and sorting parameters. This action is read-only and idempotent — calling it multiple times with the same parameters will return the same results without side effects.

Tool to list all identities associated with a specific end user. Use when you need to retrieve the email addresses and/or phone numbers linked to an end user account. Supports optional filtering by identity type (email, phone_number).

List all group memberships in your Zendesk account. Group memberships link users to groups, determining which agents belong to which support groups. Use when you need to audit group assignments, manage team memberships, or enumerate the relationship between users and groups. This action supports both offset pagination (page, per_page) and cursor pagination (page_size, page_after, page_before). It also supports sideloading related users and groups via the include parameter. This action is read-only and idempotent.

List all users belonging to a specific Zendesk group. Use when you need to retrieve all members of a particular group, with optional filtering by user role, permission set, or external ID. This action is read-only and idempotent.

List survey responses from Zendesk Guide. Use when you need to retrieve CSAT survey responses, analyze customer satisfaction scores, or monitor survey completion rates. Survey responses are available on Support Professional plan and above, and Zendesk Suite Growth plan and above. This action is read-only and idempotent.

List available CSAT (Customer Satisfaction) surveys in Zendesk Guide. Use when you need to retrieve survey definitions, check which surveys are enabled/disabled, or get survey questions and versions. The response includes survey IDs, states, creation timestamps, and question arrays. This is a read-only, idempotent operation.

Export custom object records incrementally using cursor-based pagination. Use this action when you need to retrieve all changes to custom object records since a specific time, with support for large result sets through cursor-based pagination. The start_time parameter is required for the initial request; subsequent pages use the cursor returned in previous responses. This is a read-only, idempotent operation that returns records with their custom field values and change timestamps. The action supports filtering to exclude deleted records and configurable page sizes. Rate limited to 10 requests per minute.

List job statuses from Zendesk. Shows the status of all background jobs that have been initiated, including those created by bulk operations like bulk updates, imports, or exports. Each job status includes progress information, completion status, and any results from individual tasks. Use this action to track the progress of long-running operations or check if background tasks completed successfully. Use this action when you need to check the status of background jobs, monitor bulk operation progress, or verify that asynchronous tasks have finished processing.

List all translation locales available for your Zendesk account. Use when you need to retrieve the available locales for translation purposes, check which languages are enabled, or get locale metadata including the locale code, display name, and creation timestamps. This is a read-only, idempotent operation that supports pagination.

Retrieve the definitions of all actions that a macro can perform in Zendesk. Use this action when you need to discover what actions are available for macro creation, understand the available values for each action type, or build a macro configuration interface. The response includes action fields, their display titles, types, and available value options. Common macro actions include: setting ticket status, priority, or type; assigning agents or groups; adding/removing tags; setting custom fields; and adding comments.

List supported actions for macros in Zendesk. Use when you need to discover what field modifications are available when creating or editing macros. This endpoint returns the available action fields that can be set in a macro (e.g., status, priority, assignee, etc.) along with their possible values. This is useful for validating macro configurations or building macro management interfaces. This action is read-only and idempotent.

List all attachments associated with a specific Zendesk macro. Use when you need to retrieve the files attached to a macro, such as images used in macro content or documents included in automated responses. This is a read-only operation that returns the attachment metadata including filename, content type, size, and download URL.

List all macro categories available to the current Zendesk account. Use when you need to retrieve or browse available macro categories for organizing and applying macros to tickets. This action is read-only and idempotent.

List all shared and personal macros available in your Zendesk account. Use when you need to retrieve, audit, or review the macros configured for automating ticket responses and actions. Macros are saved response templates that agents can apply to tickets. Supports filtering by access level, active status, category, and group. Results can be sorted by name, creation date, update date, or usage statistics.

List group memberships for a specific Zendesk group. Use when you need to retrieve all members assigned to a particular group, audit group membership, or understand which users belong to a specific support group. This action is read-only and idempotent. Supports both offset pagination (page, per_page) and cursor pagination (page_size, page_after, page_before). Also supports sideloading users and groups via the include parameter.

List group memberships for a specific Zendesk user. Use when you need to retrieve all groups a user belongs to, audit user group assignments, or understand which support groups a specific user is a member of. This action is read-only and idempotent. Supports both offset pagination (page, per_page) and cursor pagination (page_size, page_after, page_before). Also supports sideloading users and groups via the include parameter.

List all monitored X (Twitter) handles configured in your Zendesk account. Use when you need to retrieve all Twitter handles that are being monitored for the X channel integration. This is a read-only, idempotent operation.

List Object Trigger Action and Condition Definitions for a custom object in Zendesk. Use when you need to discover the available trigger actions and conditions that can be used to create or configure triggers on a custom object. This returns metadata about what types of automations are possible for the specified custom object. This is a read-only, idempotent operation that returns the available trigger definitions.

List all triggers for a specific custom object in Zendesk. Use when you need to discover, audit, or review the triggers configured for a custom object type. Triggers are business rules that automatically perform actions based on conditions. This action retrieves triggers associated with a custom object defined in your Zendesk instance. Each trigger defines conditions and corresponding actions that run when records meet those conditions.

List open requests from Zendesk. Use this action when you need to retrieve all requests with "open" status for the authenticated user. Supports sorting by creation date or last update time. This action is read-only and idempotent.

List all custom organization fields for the Zendesk account. Use this action when you need to retrieve or audit the custom organization field definitions configured in your Zendesk instance. Organization fields are used to store additional metadata about organizations beyond the standard attributes. Supports cursor-based pagination for retrieving large numbers of fields. Use resolve_dc=true to get resolved dynamic content placeholders instead of raw template strings.

List organization memberships in Zendesk. Use when you need to retrieve all organization memberships, which link users to organizations. Supports pagination and sorting options to navigate large result sets efficiently.

List organization memberships for a specific organization in Zendesk. Use when you need to retrieve all users who are members of a particular organization, including their membership metadata like default status and ticket viewing permissions. Supports pagination and sorting options to navigate large result sets efficiently. This action is read-only and idempotent - calling it multiple times with the same organization ID will return the same result.

List all organization merge operations for a specific organization in Zendesk. This action retrieves the merge history showing which organizations were merged into or out of the specified organization. Use this action when you need to audit organization merge history or track the consolidation of organizations. Supports pagination to handle large result sets efficiently. This is a read-only, idempotent operation.

List requests for a specific Zendesk organization. Use when you need to retrieve all requests associated with a particular organization. This action returns request details including subject, status, priority, requester, and timestamps. Pagination is available for large result sets.

List Organization Subscriptions in Zendesk. Returns organization subscriptions with pagination support (cursor and offset). Use when you need to retrieve all organization subscriptions or need to paginate through results. End users only see their own subscriptions.

List all organization subscriptions for a specific Zendesk organization. Returns subscriptions that link users to organizations. Use when you need to see which users are subscribed to a particular organization or audit organization membership. This action is read-only and idempotent. Paginate by following next_page until null to avoid missing subscriptions.

List all users associated with a specific Zendesk organization. Returns a paginated list of users who are members of the organization. Use when you need to see all users belonging to a particular organization, retrieve organization membership information, or audit organization access. Supports filtering by role, permission sets, and external IDs. Supports pagination via page number or cursor-based pagination.

List all permission policies for a custom object in Zendesk. Use this action when you need to discover the access control configuration for a custom object, understand what roles have permissions, or retrieve permission metadata for access control management. This is a read-only, idempotent operation. This action is useful for reviewing permission policies applied to custom objects in Zendesk.

List all available public locales that can be used for translations in Zendesk. Use when you need to enumerate supported languages/locales for your Zendesk account, display language options to users, or determine which locales are available for ticket or article translations. This is a read-only, idempotent operation that returns the complete list of public locales with no pagination parameters.

List all remote authentication configurations in your Zendesk account. Use this action when you need to enumerate SSO configurations, check which authentication methods are enabled, or retrieve metadata about remote authentication settings for agents and end users. This is a read-only, idempotent operation that returns all configured remote authentication providers including SAML, LDAP, JWT, and OAuth configurations.

List comments on a Zendesk request. Use when you need to retrieve all comments from a specific ticket request to understand the conversation history or gather context for responding. The comments are returned in chronological order. Each comment includes author information, content (both plain text and HTML formats), attachments, and metadata about how and when it was created.

List ticket requests in Zendesk. This action retrieves a paginated list of requests, supporting sorting by creation or update time. Use when you need to fetch all or filtered ticket requests from your Zendesk account. This action is read-only and idempotent.

List Resource Collections for the Zendesk account. Use when you need to retrieve, audit, or review the resource collections configured in your Zendesk account. Resource collections are groups of related resources that can be managed together. This is a read-only action that returns paginated results. Use per_page to control page size.

List satisfaction ratings for tickets in Zendesk. Use when you need to retrieve customer satisfaction feedback, analyze CSAT scores, or review ratings with their associated tickets and assignees. Supports both offset and cursor pagination for large datasets.

List all active sessions in your Zendesk account. If authenticated as an admin, returns all the active sessions for all users. Otherwise, returns only the sessions for the authenticated user. Use this action to monitor active user sessions, track login activity, or manage session security. Use when you need to audit active user sessions, investigate security events, or retrieve session information for user activity monitoring.

List all sharing agreements for your Zendesk account. Sharing agreements define connections between Zendesk accounts for sharing tickets. This action is read-only and idempotent — use it to view current sharing relationships or check agreement status.

Retrieve side conversation events for incremental export. Returns events created since the specified start_time in chronological order. Use when you need to export or sync side conversation events for backup, analytics, or integration purposes. This action supports pagination via the next_page URL which contains a next_start_time parameter — pass that timestamp as start_time for subsequent requests. Only available to Admins. Note: This is a read-only, idempotent action suitable for building event pipelines or audit trails.

List all events for a specific side conversation on a Zendesk ticket. Returns events in chronological order including creation, replies, and state updates. Use this action when you need to view the complete history of a side conversation including all messages and state changes. Side conversations are private agent-to-agent communications that don't appear in the main ticket thread.

List Zendesk requests with the 'solved' status. Useful for reviewing completed customer requests, generating reports on resolution times, or tracking customer satisfaction. Use this action when you need to retrieve requests that have been marked as solved.

List all support addresses (recipient addresses) configured in your Zendesk account. Use when you need to enumerate available support email addresses, check which address is set as default, or retrieve address metadata like verification status and brand associations. This is a read-only, idempotent operation that supports both cursor and offset pagination.

List suspended tickets in Zendesk. Suspended tickets are tickets that were automatically held for review due to spam detection, banned content, or other filtering rules. This action is read-only and idempotent — use it to review suspended tickets and determine if they should be recovered or deleted.

List Zendesk tags in order of popularity. Use when you need to view all available tags in your Zendesk account, or when you need to find tags that are most frequently used across tickets.

List the 25 most recent target failures in Zendesk. Target failures occur when a target (webhook, callback, or external integration) fails to execute properly. Each failure record includes the request sent, response received, and status code. Use this action to monitor and troubleshoot failing integrations.

List all targets for the current Zendesk account. Use when you need to retrieve, audit, or review the targets configured in your Zendesk account. Targets are endpoints that receive data when triggers or automations fire. This is a read-only, idempotent action with no required parameters.

List all audits (change history) for a specific Zendesk ticket. Use when you need to track all changes made to a ticket including comments, status changes, assignments, and other modifications. Each audit contains one or more events representing individual changes. This action is read-only and supports both traditional offset pagination and cursor-based pagination for large datasets. Audits are returned in chronological order by default. Note: This action retrieves the complete audit trail which is useful for compliance, troubleshooting, and understanding ticket evolution.

List all ticket audits from Zendesk. Returns a paginated list of audit records, each containing events that describe changes made to tickets. Audits capture all changes including comments, status changes, assignments, and field updates. Archived tickets are not included in the results. Use cursor pagination (page_after, page_before, page_size) to navigate through results efficiently.

List all collaborators (CC'd users) on a Zendesk ticket. Use when you need to see who is currently CC'd on a ticket, such as when coordinating with multiple stakeholders or before adding/removing collaborators. Each collaborator is a user object with basic profile information. Paginate through results using page and per_page parameters.

List Ticket Content Pins returns all content pins for a specified ticket. Use when you need to retrieve all pinned content items on a ticket. If ticket_id is not provided, returns all content pins for the account. _tags =

List Email CCs for a Ticket. Use when you need to retrieve a list of users who are CC'd on a specific Zendesk ticket. This endpoint returns all email CC records associated with the ticket, including user details and timestamps.

List Ticket Field Options - Returns a list of custom ticket field options for dropdown and multi-select ticket fields. Use this action to retrieve the available choices users can select when filling out a custom ticket field. This action is read-only and idempotent. Note: Only works with dropdown, tagger, and multi-select custom ticket fields; standard fields like text or date do not have options.

List all system and custom ticket fields in Zendesk. Use when you need to retrieve field definitions for building forms, validating field values, or understanding available ticket field structure. Supports cursor-based pagination for large datasets. When creator=true is specified, includes creator_user_id and creator_app_name for each field. Locale parameter affects dynamic content variants for title_in_portal.

List all followers on a Zendesk ticket. Use when you need to see who is following a ticket, such as when coordinating with stakeholders or managing ticket notifications. Followers receive notifications about the ticket. Each follower is a user object with basic profile information. Paginate through results using page and per_page parameters.

List all ticket forms configured in your Zendesk account. Use when you need to enumerate available ticket forms, retrieve form metadata like display names and visibility settings, or audit which ticket forms are active and visible to end users or agents. Supports filtering by active status, end-user visibility, form type (standard or service catalog), and brand association. Also supports both traditional offset pagination and cursor-based pagination.

List incidents linked to a problem ticket in Zendesk. Use when you need to retrieve all incident tickets that share the same root cause as a problem ticket. Incidents are tickets of type 'incident' that are related to a problem ticket via the problem_id field. Supports both offset and cursor-based pagination.

List ticket metric events in Zendesk that occurred on or after a specified time. This action supports incremental data export — use the end_time from one response as the start_time for the next request to retrieve subsequent events. This action is read-only and idempotent — use it to monitor ticket metrics, track SLA compliance, or build analytics dashboards. Note: deleted tickets can create orphan metric events; use exclude_deleted=true to filter these out.

List Zendesk ticket problems. Use when you need to retrieve all tickets of type 'problem' in your Zendesk account. The response is always ordered by updated_at by default; use sort_by and sort_order parameters to customize. Supports both offset and cursor-based pagination. Note: Problems are tickets with type='problem'. This endpoint specifically returns problem-type tickets which are linked to other incidents that share the same root cause.

List ticket skips for a specific ticket from Zendesk. Use when you need to retrieve all skip records associated with a particular ticket, such as when reviewing which agents skipped working on a ticket or analyzing skip patterns. This action is read-only and idempotent. It returns a list of skip records that include the reason for skipping, who skipped it, and when.

List all ticket triggers for the current Zendesk account. Use when you need to retrieve, audit, or review the trigger rules configured in your Zendesk account. Triggers are business rules that automatically perform actions based on conditions when tickets are created or updated. Supports filtering by active status and category. Also supports both traditional offset pagination and cursor-based pagination for sorting.

List tickets from a specific Zendesk view. Use this action when you need to retrieve all tickets that match a view's conditions, such as for reporting, bulk operations, or analyzing tickets filtered by specific criteria. This action is read-only and idempotent.

List all ticket trigger categories in your Zendesk account. Use when you need to retrieve, audit, or review the trigger category organization for your business rules and automations. Supports filtering with sort options (position, name, created_at, updated_at) and can include rule counts via the `include` parameter to show how many triggers are in each category.

List custom user field options for a given user field. Use when you need to retrieve the dropdown or tag options available for a custom user field in Zendesk. This action fetches the configurable options that can be selected for custom user fields of type dropdown, tagger, or similar multi-option field types.

List all custom user fields configured in your Zendesk account. Use when you need to retrieve the schema of user-defined fields (like dropdown options, validation patterns, or field types) to build dynamic forms or validate field values.

List all groups that a specific Zendesk user belongs to. Use when you need to find which support groups a user is a member of, audit team memberships, or retrieve group membership information for a particular user. This action supports both offset pagination (page as integer, per_page) and cursor pagination (page as object with size/after/before). It also supports excluding deleted groups and sorting results. This action is read-only and idempotent.

Tool to list all identities for a specific Zendesk user. Use when you need to retrieve all email addresses, phone numbers, or other contact methods associated with a user. Supports filtering by identity type and cursor-based pagination.

List organization memberships for a specific Zendesk user. Use when you have a user_id and need to retrieve all organizations that user belongs to. Returns membership details including default status, view_tickets permission, and organization info. This action is read-only and idempotent - calling it multiple times with the same user_id will return the same result.

List organizations associated with a specific Zendesk user. Use when you have a user_id and need to retrieve all organizations that user belongs to. Returns organization details including name, domain names, tags, and custom fields. This action is read-only and idempotent - calling it multiple times with the same user_id will return the same result.

List ticket requests for a specific Zendesk user. Use when you need to retrieve all requests associated with a particular user ID. This is useful for viewing a user's request history or monitoring their open tickets. This action is read-only and idempotent.

List all sessions for a specific Zendesk user. Returns details about each active session including authentication time and last seen time. Use this action to monitor session activity for a specific user, investigate security events, or audit login history for account troubleshooting. Use when you need to see all active sessions for a particular user, track their login activity, or investigate potential unauthorized access.

List ticket skips for a specific user from Zendesk. Use when you need to retrieve all skip records associated with a particular user, such as when analyzing which tickets a user has skipped or reviewing their skip history. This action is read-only and idempotent. Note that archived tickets are not included in the results.

List User's Organization Subscriptions - retrieves organization subscriptions for a specific user. Use when you need to get all organization subscriptions associated with a particular user, including the organization IDs and creation timestamps. Supports both cursor and offset pagination. End users only see their own subscriptions. This is a read-only operation that does not modify any data.

List the definitions of the conditions and actions available for constructing views in Zendesk. Use this action when you need to discover what filter fields, operators, grouping options, and sorting options are available for building or modifying views. This is a read-only action that returns the schema/structure for view definitions.

List shared and personal views available to the current user in Zendesk. Use when you need to retrieve, audit, or review the views configured in your Zendesk account. Views are saved ticket filters that help organize and prioritize support work. Supports filtering by access level (personal/shared/account), active status, and group. Supports both traditional offset pagination and cursor-based pagination.

Retrieves a compacted list of shared and personal views available to the current user in Zendesk. Use when you need to quickly fetch a lightweight list of views without full details. This endpoint returns essential view information suitable for dropdown menus or quick selection lists. Unlike the standard /views endpoint, this compact version provides a streamlined response with the most commonly needed fields.

Get multiple Zendesk views by their IDs. Use when you need to retrieve specific views by their IDs in a single request rather than fetching them one by one. The IDs should be provided as a comma-separated string. This action is read-only and idempotent. Returns only views that exist and for which the user has permission.

Log out multiple users in Zendesk by ending their active sessions. This action is irreversible — the affected users will be logged out and will need to re-authenticate. Use when you need to immediately terminate sessions for multiple users (e.g., after security incident, offboarding, or credential revocation). The operation accepts up to 100 user IDs at a time.

Set a specified identity as the primary identity for an end user in Zendesk. This is a collection-level operation - after making an identity primary, you should reload the entire identities collection to get the updated state. An end user can only make an email identity primary if the email is verified. Use when a user wants to change their primary email or phone number for notifications.

Set a specific organization membership as the default for a user in Zendesk. Use when you need to change which organization is the primary/default for a user. Only one organization can be the default at a time. This action is idempotent - setting the same membership as default multiple times will succeed without side effects.

Change a public comment to private on a Zendesk ticket audit. Use when you need to convert a previously public-facing comment to an internal note that is not visible to the end user. This action makes the comment private by updating the ticket audit. This is useful when information was shared publicly by mistake and needs to be restricted to agents only. Note: This action only works on existing audits and cannot be undone once the comment is made private.

Tool to set a user identity as the primary identity for a Zendesk user. Use when you need to change which email address or identifier is the primary contact method for a user. This action may affect which email notifications the user receives.

Make a public ticket comment private in Zendesk. This action changes the visibility of a comment from public to internal-only, so only agents can view it. Use this action when you need to convert a customer-facing comment to an internal note after the fact. Note: Only agents can make comments private; end users cannot use this endpoint.

Marks multiple tickets as spam in Zendesk. This action is irreversible — the tickets will be marked as spam and moved to the suspended tickets queue. The submitter will also be marked as spam and blocked from submitting further tickets. Use when cleaning up spam or unwanted tickets to protect your support queue. Returns a job_status payload for tracking the bulk operation. Note: Tickets marked as spam are moved to the suspended tickets queue and cannot be recovered through normal means.

Merge two Zendesk organizations by combining all users, tickets, and data from the losing organization into the winning organization. This action is irreversible — once merged, the losing organization and all its data cannot be recovered. Use when you need to consolidate duplicate organizations or combine organization data into a single organization.

Merges multiple tickets into a target ticket in Zendesk. The source tickets are merged into the target ticket and then deleted. This is an asynchronous operation that returns a job status. Use when you need to consolidate duplicate or related tickets into a single ticket. Important: This action is irreversible - source tickets are permanently merged and deleted once the operation completes. Always verify the target_ticket_id and source_ticket_ids before executing.

Open a Zendesk user's profile in a specified agent's browser. Use when an agent needs to view a specific user's profile during an active call or session. This action triggers the Zendesk Talk dashboard to display the user's information in the agent's interface.

Permanently deletes a soft-deleted user from Zendesk. This action is irreversible - once a user is permanently deleted, it cannot be recovered. Use this action to remove users that were previously soft-deleted using the delete_user action. Use this action when you need to permanently remove a user that has already been deleted and is no longer accessible through normal operations. This action requires appropriate admin permissions.

Preview a Zendesk view by constructing conditions and execution settings to see which tickets match. Use when you need to test or validate view conditions before saving, or to retrieve a live preview of tickets matching specific filter criteria without creating a permanent view. This action is useful for verifying view logic, testing conditions, and previewing results before committing to a saved view.

Preview ticket count for a view in Zendesk. Returns the number of tickets matching the specified conditions before saving the view. Use when you want to verify how many tickets will match a view's filter criteria before creating or updating a view. This action sends a POST request to /api/v2/views/preview/count with view conditions and returns the matching ticket count. Rate limited to 5 requests per minute, per view, per agent.

Recover multiple suspended tickets in Zendesk. Use when you need to restore tickets that have been suspended (e.g., auto-replied emails, bounced messages). Takes up to 100 ticket IDs as input and restores them to normal ticket status. This action is irreversible — recovered tickets return to normal processing.

Redact sensitive content from a ticket comment in Zendesk using the Agent Workspace method. Use when you need to permanently remove or hide sensitive information such as personal data, credentials, or inappropriate content from ticket comments. This action is irreversible — redacted content cannot be recovered once removed. Note: Requires Agent Workspace to be enabled and (for Enterprise accounts) agents need a custom role with redaction permissions. Closed tickets cannot have comments redacted.

Renew the current Zendesk session and obtain a new authenticity token. Use when the current session token is expiring or needs to be refreshed to maintain an active authenticated connection. This action extends the session lifetime without requiring full re-authentication.

Reorder App Installations For Location. Creates or updates the relevant location installation with a specified installation order. This action requires admin-level access. Use when you need to change the display order of apps in a specific Zendesk location (e.g., nav bar, ticket sidebar).

Reorder Custom Fields of an Object. Updates the display order of custom object fields based on the provided field IDs. Use when you need to change the order of fields displayed in a custom object's record layout. This action is idempotent — re-running with the same field IDs in the same order will produce the same result.

Reorder Organization Fields. Updates the display order of organization fields based on the provided field IDs. Use when you need to change the order of organization fields displayed in Zendesk. This action is idempotent — re-running with the same field IDs in the same order will produce the same result.

Reorder Ticket Fields. Updates the display order of ticket fields based on the provided field IDs. Use when you need to change the order of standard ticket fields displayed in the ticket form. This action is idempotent — re-running with the same field IDs in the same order will produce the same result. This action requires admin permissions.

Reorder Ticket Triggers. Updates the firing order of ticket triggers based on the provided trigger IDs. Use when you need to change the priority or execution order of ticket triggers in your Zendesk account. Important constraints: You must include EVERY ticket trigger ID in your account. Omitting any trigger ID returns 404 Forbidden. Additionally, reordering is not permitted if you have more than one ticket trigger category (returns LimitOneCategory error). This action is idempotent - re-running with the same trigger IDs in the same order will produce the same result.

Reorder User Fields. Updates the display order of custom user fields based on the provided field IDs. Use when you need to change the order of user fields displayed in user profiles or forms. This action requires admin-level access. This action is idempotent — re-running with the same field IDs in the same order will produce the same result.

Action to reply to a Zendesk ticket by adding a comment.

Send a verification email to an end user to verify ownership of their email address identity. The end user receives an email with a link to confirm their identity. Use when you need to verify an end user's email address identity in Zendesk, such as when creating new end users or resolving identity verification issues. Note: This action can only be performed by verified end users.

Send a request to create a user in Zendesk. This sends the owner a reminder email to update their user profile information. Use when you want to prompt a user to complete their profile through the request flow rather than creating directly. This action is useful for onboarding flows where you want to collect user information through an email-based request rather than creating the user directly.

Send a verification email to a user to verify ownership of their email address identity. The user receives an email with a link to confirm their identity. Use when you need to verify a user's email address identity in Zendesk, such as when creating new users or resolving identity verification issues. Note: This action sends a verification email to the user's identity address.

Restores multiple previously deleted tickets in Zendesk. Use when you need to recover tickets that were deleted and need to be restored in bulk. This action is reversible - tickets can be deleted again after restoration. Note: Only tickets in 'deleted' status can be restored.

Restores a previously deleted ticket in Zendesk. Use when a ticket was accidentally deleted and needs to be recovered. The restored ticket will return to its previous state with all associated data intact. This action is reversible — tickets can be deleted again after restoration if needed.

Search for Zendesk automations by their title. Use when you need to find automations in your Zendesk account by searching for keywords in their titles. Automations are business rules that automatically perform actions when certain conditions are met. This action supports filtering by active status and sorting results.

Search and filter custom object records in Zendesk using text queries and field filters. Returns paginated results with cursor-based navigation. Use when you need to find specific records within a custom object type, apply text searches or structured filters, and navigate through large result sets. This is a read-only operation. This action is useful for discovering records, running filtered queries on custom objects, and implementing paginated browsing through custom object data.

Search for Zendesk macros by their title. Use when you need to find macros in your Zendesk account by searching for keywords in their titles. Macros are pre-defined responses or actions that can be applied to tickets to automate repetitive tasks. This action supports filtering by access, active status, category, and group, as well as sorting results.

Search for triggers associated with a custom object in Zendesk. Use when you need to find triggers based on their title, description, or active status within a specific custom object. This is useful for auditing, managing, or reviewing automation rules for custom objects. Supports both cursor-based pagination (using 'sort' parameter) and offset pagination (using 'sort_by' parameter). Filter by 'active' to show only enabled or disabled triggers.

Search organizations in Zendesk by external ID or name. Returns an array of organizations matching the provided criteria. Use when you need to find specific organizations by their identifier or name. An empty organizations array with count=0 means no matches found. Multiple organizations may share similar names — verify the correct organization via external_id or domain_names before proceeding with operations.

Search for requests in Zendesk using query syntax. Use when you need to find customer requests across Zendesk using flexible search criteria such as status, priority, subject, or requester information. Returns paginated results with request details. This action is read-only and idempotent - searching for requests does not modify any data.

Search for Zendesk ticket triggers by their title. Use when you need to find triggers in your Zendesk account by searching for keywords in their titles. Triggers are business rules that automatically perform actions when certain conditions are met on tickets. This action supports filtering by active status, sorting, and sideloading usage statistics. This is a read-only and idempotent action that queries existing triggers without making any changes.

Search for Zendesk views by their title. Use when you need to find views in your Zendesk account by searching for keywords in their titles. Views are saved searches that display tickets matching specific conditions. This action supports filtering by access level, active status, group, and sorting results.

Search for Zendesk users by query or external ID. Use when you need to find users using flexible search criteria with Zendesk search syntax (e.g., partial name matches, email patterns, notes, phone numbers). For exact email lookups, consider using the 'Search Zendesk Users' action instead.

Send a notification to currently open instances of a Zendesk app. Use when you need to push real-time notifications or data to a Zendesk app that is currently open in an agent's interface. The notification triggers an event in the app, which can then respond with custom behavior (e.g., display a popup, update UI, trigger a workflow). Only works with apps that are currently open in the Zendesk interface.

Sets one or more custom ticket statuses as the default for their respective categories. Use this action when you need to specify which custom status should be the default (fallback) status for a given category (open, pending, solved, etc.). This operation is idempotent — running it multiple times with the same IDs will produce the same result. Allowed for: Admins only. Note: The IDs should be valid custom ticket status IDs that exist in your Zendesk account.

Set a group membership as the default for a specific user in Zendesk. Use when you need to mark a user's group membership as the default, meaning tickets assigned directly to the agent will assume this membership's group. Requires both the user ID and the group membership ID. This action is useful for managing default routing preferences for agents in your Zendesk instance. Note that only one group membership can be the default at a time - setting a new default will automatically unset the previous default.

Set an organization as the default for a user in Zendesk. Use when you need to change which organization is the primary/default for a user by specifying the organization ID directly. Only one organization can be the default at a time. This action is idempotent - setting the same organization as default multiple times will succeed without side effects.

Set organization tags in Zendesk by making a POST request to replace the tags on an organization. Use when you need to categorize or label organizations with specific tags for filtering and organization purposes. This operation replaces all existing tags on the organization with the new set provided. Note: This action is not idempotent as it replaces existing tags rather than adding to them.

Show a custom object access rule by its ID. Use when you have a custom_object_key and access_rule_id and need to retrieve the access rule's details including its conditions, title, description, and timestamps. This is a read-only operation that does not modify any data. This action is useful for reviewing access control rules applied to custom objects in Zendesk.

Show a specific automation by its ID. Use when you need to retrieve details of a single automation rule in your Zendesk account, such as for auditing, modifying, or understanding what actions and conditions are configured for a particular automation. This action is read-only and idempotent.

Show changes to a ticket that would result from applying a macro. Use when you need to preview what changes a macro would make to a ticket before actually applying it. This allows you to review the changes that would be applied, such as assignee changes, group reassignments, comments, or custom field updates. This action is read-only and idempotent — it does not actually modify the ticket.

Get details of a specific Zendesk custom object by its key. Use when you have a custom object key and need to retrieve its metadata including name, description, attachment settings, visibility settings, and creation/update timestamps. This is a read-only, idempotent operation that returns the full custom object definition.

Get details of a specific Zendesk custom object record by its key and record ID. Use when you have a custom object key and record ID and need to retrieve the record's metadata including name, custom fields, timestamps, and photo. This is a read-only, idempotent operation that returns the full custom object record definition. Photo is only available if `allows_photos` is enabled on the custom object.

Show a specific dynamic content item by its ID. Use when you have a dynamic content item ID and need to retrieve its details, including name, default locale, placeholder value, variants, and creation/update timestamps. This is a read-only, idempotent operation that returns a single dynamic content item.

Show a specific variant of a dynamic content item in Zendesk. Use when you have a dynamic_content_item_id and dynamic_content_variant_id and need to retrieve the variant's details including its content, locale, active status, and timestamps. This is a read-only operation. Dynamic content items allow you to create reusable content that can be localized into multiple variants for different languages or contexts.

Show a specific macro by its ID. Use when you need to retrieve details of a single macro in your Zendesk account, such as for auditing, modifying, or understanding what actions and conditions are configured for a particular macro. Macros are saved response templates that agents can apply to tickets. Supports optional sideloads for usage statistics and additional metadata via the `include` parameter.

Show a macro replica (unpersisted macro representation) based on a macro ID and ticket ID. Use when you need to preview how a macro will look when applied to a specific ticket, allowing you to see the actions and values that will be applied without actually applying the macro. This is useful for testing macro configurations or displaying macro previews in your interface. This action is read-only and idempotent.

Retrieve multiple dynamic content items by their identifiers. Use when you have specific dynamic content item IDs or names and need to fetch their metadata including placeholder, default locale, variants, and outdated status. This is a read-only, idempotent operation. The 'identifiers' parameter accepts comma-separated values; omit it to retrieve all items (use with caution on accounts with many items).

Show details of many email notifications in Zendesk. Use when you need to retrieve multiple email notifications at once by their IDs, associated comment IDs, or associated ticket IDs. At least one of the filter parameters (ids, comment_ids, or ticket_ids) is required.

Show many job statuses by their IDs in Zendesk. Use this action when you have multiple job status IDs from bulk operations (like ticket updates, user merges, or ticket merges) and need to check their status in a single request. Each ID in the comma-separated list will return its corresponding job status object if found. Endpoint: GET /api/v2/job_statuses/show_many

Show many Zendesk organizations by their IDs or external IDs. Use when you need to retrieve multiple organizations in a single API call. Accepts up to 100 organization IDs or external IDs as comma-separated lists. Only one of ids or external_ids should be provided. Returns organization objects with all standard fields including name, domain_names, tags, and organization_fields.

Retrieve multiple ticket fields by their IDs or keys in a single request. Use when you have specific ticket field identifiers (numeric IDs like '123' or keys like 'priority', 'status', 'subject') and need to fetch their complete metadata including type, title, required status, custom options, and portal visibility settings. This is a read-only, idempotent operation. Up to 100 fields can be retrieved per request. Either `ids` or `keys` parameter can be used, but not both simultaneously.

Show multiple ticket forms by their IDs. Use when you need to retrieve specific ticket forms by their IDs to display form details, validate form availability, or bulk fetch form configurations. The `ids` parameter accepts a comma-separated list of ticket form IDs (e.g., '1,2,3'). Returns an empty ticket_forms array for non-existent IDs without error. Supports optional filtering by active status, end-user visibility, brand association, and default form fallback behavior.

Show multiple tickets by their IDs. Use when you need to retrieve specific tickets by their IDs to display ticket details, compare tickets, or bulk fetch ticket information. The `ids` parameter accepts a comma-separated list of ticket IDs (e.g., '35436,35437'). Returns tickets for valid IDs only; non-existent IDs result in an empty tickets array without error.

Retrieve multiple Zendesk users by their numeric IDs or external IDs. Use when you have a list of user IDs (from ticket payloads, search results, etc.) and need to fetch full user details for multiple users at once. Accepts up to 100 IDs per request. Provide either `ids` or `external_ids`, not both.

Show a specific trigger for a custom object in Zendesk. Use when you need to retrieve details of a single trigger, such as for auditing, understanding its conditions and actions, or preparing modifications. This action is read-only and idempotent.

Get details of a specific permission policy for a Zendesk custom object by its ID. Use when you have a custom_object_key and permission policy ID and need to retrieve the policy's details including the role name and record operation permissions (create, read, update, delete). This is a read-only, idempotent operation that does not modify any data. This action is useful for reviewing permission policies that control access to custom object records in Zendesk.

Show a single request in Zendesk. Use when you need to retrieve details of a specific request by its ID, including subject, description, status, priority, requester information, and other metadata. This action is read-only and idempotent.

Show a specific target by its ID. Use when you have a target ID and need to retrieve its details including title, type, active status, and creation timestamp. This is a read-only, idempotent operation that returns a single target object. This action is irreversible for data retrieval - it only reads target information, no destructive changes occur.

Show a target failure in Zendesk. Use when you have a target_failure_id and need to retrieve details about a failed target execution, including the HTTP status code, raw request/response data, and consecutive failure count. This is a read-only operation.

Show a specific ticket field by its ID. Use when you need to retrieve details of a single ticket field in your Zendesk account, such as for auditing, understanding field configuration, or validating field properties. This action is read-only and idempotent.

Show Ticket Field Option - Retrieves a specific custom ticket field option for dropdown and multi-select ticket fields. Use this action when you have a ticket_field_id and a ticket_field_option_id and need to retrieve the details of that individual option. This action is read-only and idempotent. Note: Only works with dropdown, tagger, and multi-select custom ticket fields; standard fields like text or date do not have options.

Show a specific trigger by its ID. Use when you need to retrieve details of a single trigger in your Zendesk account, such as for auditing, modifying, or understanding what actions and conditions are configured for a particular trigger. This is useful for reviewing business rules before making changes or understanding automation behavior. This action is read-only and idempotent.

Show a specific ticket trigger category by its ID. Use when you need to retrieve details of a single trigger category, such as for auditing or understanding the organization of your ticket triggers. This action is read-only and idempotent.

Tool to show a specific user identity by user ID and identity ID. Use when you need to retrieve detailed information about a particular identity associated with a Zendesk user. This action is read-only and idempotent - it only retrieves data without modifying anything.

Immediately removes a user from an organization in Zendesk. Use when you need to unassign a user from an organization membership. This action is irreversible - the user will no longer be associated with the organization.

Update an existing access rule for a custom object in Zendesk. Access rules control which records of a custom object users can access based on conditions. Use this action when you need to: - Change an access rule's title or description - Modify the conditions that determine when the rule applies - Update access permissions for custom object records This action is idempotent — re-running with the same parameters will produce the same result.

Update an existing automation in Zendesk. Automations are business rules that automatically perform actions on tickets when certain conditions are met. Use this action when you need to: - Change an automation's title, active status, or position - Modify the conditions that trigger the automation - Update the actions the automation performs - Deactivate an automation without deleting it This action is idempotent — re-running with the same parameters will produce the same result.

Update the settings for the currently authenticated Zendesk user. Use when modifying UI preferences like keyboard shortcuts, onboarding tooltips, theme preferences, or shared views order. This action modifies the caller's own settings only.

Update an existing custom object in Zendesk. Custom objects are user-defined data structures that allow you to store and manage custom data types. Use this action when you need to: - Change a custom object's title, description, or pluralized title - Update visibility settings (include_in_list_view) - Enable or disable attachments and photos for the custom object This action is idempotent — re-running with the same parameters will produce the same result.

Update an existing custom object field in Zendesk. Custom object fields define the structure and properties of data within a custom object. Use this action when you need to: - Rename a custom object field - Update the description or display properties - Change the field's position in the UI - Enable or disable a field - Set validation patterns or make fields required This action is idempotent — re-running with the same parameters will produce the same result.

Update an existing record for a custom object in Zendesk. Use when you need to modify an existing custom object record. This action updates fields on a custom object record. You can update the name, external_id, and custom_object_fields as needed.

Update an existing custom ticket status in Zendesk. Custom ticket statuses allow you to define additional statuses beyond the standard statuses (new, open, pending, solved, closed) for your ticket workflow. Use this action when you need to: - Change the labels shown to agents or end users for a custom status - Update the descriptions explaining when to use the status - Activate or deactivate a custom status - Modify how a custom status appears in the ticket interface This action is idempotent — re-running with the same parameters will produce the same result. Requires admin permissions in Zendesk.

Update an existing deletion schedule in Zendesk. Deletion schedules define automated rules for deleting tickets, users, attachments, or other records based on specified conditions. Use this action when you need to: - Change a deletion schedule's title, description, or active status - Modify the conditions that determine which records are deleted - Pause or reactivate a deletion schedule This action is idempotent — re-running with the same parameters will produce the same result. Note: The 'object' field cannot be modified after schedule creation.

Update a dynamic content item in Zendesk. The only attribute that can be changed is the name. Use when you need to rename an existing dynamic content item after confirming its ID. Note: Dynamic content items are used to store multilingual content for use in triggers, automations, and macros. Updating the name affects all references to this item.

Update a single variant of a dynamic content item in Zendesk. Use when you need to modify the content, locale, active status, or default status of one specific variant by its ID. This action is idempotent — re-running with the same parameters will produce the same result.

Update an existing macro in Zendesk. Macros are predefined responses that agents can apply to tickets to quickly perform common actions. Use this action when you need to: - Change a macro's title or description - Modify the actions the macro performs (e.g., change status, priority, or assignee) - Activate or deactivate a macro - Restrict macro access to specific users or groups This action is idempotent — re-running with the same parameters will produce the same result.

Update multiple automations in Zendesk in a single request. Use when you need to bulk update automation settings such as position, active status, or title for multiple automations at once. Note: You might be restricted from updating some default automations. If included in a bulk update, the unrestricted automations will be updated. This action is idempotent — re-running with the same parameters will produce the same result.

Update one or more variants of a dynamic content item in Zendesk. Use when you need to bulk update variant content, active status, or default status for a specific dynamic content item. Each variant can be identified by either its ID or locale ID. This action is idempotent — re-running with the same parameters will produce the same result.

Update multiple macros in Zendesk in a single request. Use when you need to bulk update macro settings such as position or active status for multiple macros at once. This action is idempotent — re-running with the same parameters will produce the same result.

Update multiple custom object triggers in Zendesk in a single request. Use when you need to bulk update trigger settings such as position, active status, or title for multiple custom object triggers at once. This action is idempotent — re-running with the same parameters will produce the same result.

Update multiple ticket triggers in Zendesk in a single request. Use when you need to bulk update trigger settings such as position, active status, or category for multiple triggers at once. This action allows you to update the order (position) or activate/deactivate multiple triggers efficiently. This action is idempotent — re-running with the same parameters will produce the same result.

Update multiple tickets in Zendesk in a single request. Use when you need to bulk update ticket fields such as status, priority, tags, assignee, or group for multiple tickets at once. The API accepts up to 100 ticket objects per request. Changes are processed asynchronously and return a job_status object for tracking progress.

Bulk update multiple Zendesk users in a single request. Use when you need to apply the same or different updates to up to 100 users at once. Provide either a single `user` object to apply identical changes to all specified users, or an array of `users` objects for individual updates per user. The operation is asynchronous and returns a job_status that you can poll to track completion. This action is idempotent — re-running with the same parameters will apply the same updates again.

Update multiple views in Zendesk in a single request. Use when you need to bulk update view settings such as position, active status, or title for multiple views at once. Note: You might be restricted from updating some default views. If included in a bulk update, the unrestricted views will be updated. This action is idempotent — re-running with the same parameters will produce the same result.

Bulk update multiple Zendesk organizations in a single request. Use when you need to update organization details such as name, notes, details, domain names, or tags for multiple organizations at once. The action is queued as a background job - use the job_status URL to poll for completion. Maximum 100 organizations per request. Note: Agents without permission restrictions can only update 'notes' on organizations.

Update an existing custom object trigger in Zendesk. Triggers define automated actions that execute when specific conditions are met on custom object records. Use this action when you need to: - Change a trigger's title or description - Enable or disable a trigger - Modify the conditions that cause the trigger to fire - Update the actions the trigger performs This action is idempotent — re-running with the same parameters will produce the same result.

Update a custom organization field in Zendesk. Use when you need to modify an existing organization field's properties such as title, type, description, options, or other settings. All existing custom_field_options must be included on update — omitted options will be deleted. Returns the updated organization field object.

Update an existing permission policy for a custom object in Zendesk. Permission policies control which records of a custom object users with a specific role can access. Use this action when you need to: - Modify record access permissions (create, read, update, delete) for a custom role - Add or remove exceptions to what records users can access - Configure group-based exclusions for custom object record permissions This action is idempotent — re-running with the same parameters will produce the same result.

Update a ticket request in Zendesk with a comment or collaborators. Use when you need to modify request fields like status, priority, or add comments after confirming the request ID. After updating, re-fetch via ZENDESK_GET_REQUESTS if downstream logic depends on current data.

Update an existing resource collection in Zendesk. Resource collections are groups of related resources (like triggers, automations, or ticket fields) that can be managed together. Use this action when you need to: - Rename a resource collection - Modify the resources included in a collection - Update the configuration of an existing collection This action is idempotent - re-running with the same parameters will produce the same result.

Update a side conversation on a ticket in Zendesk. Use this action to modify the state (open/closed) or subject of an existing side conversation attached to a ticket. Use when you need to: - Close a side conversation that has been resolved - Reopen a closed side conversation - Update the subject line of a side conversation This action is idempotent — re-running with the same parameters will produce the same result.

Update an existing support address in Zendesk. Support addresses are email addresses that receive customer inquiries and can be configured per brand. Use this action when you need to: - Change the name of a support address - Set or change the default support address for the account - Associate a support address with a different brand Note: You cannot change the email address of an existing support address.

Update an existing ticket field in Zendesk. Ticket fields define the structure and properties of custom fields on tickets. Use this action when you need to: - Rename a ticket field or update its title - Update the description or agent-only description - Change the field's position in the ticket form - Enable or disable a ticket field - Set visibility and editability for portal and agents - Make fields required for solving tickets or creating requests - Configure validation patterns for regexp fields - Set tags for checkbox fields This action is idempotent — re-running with the same parameters will produce the same result. Requires admin permissions.

Update an existing ticket trigger in Zendesk. Triggers are business rules that automatically perform actions on tickets when certain conditions are met. Use this action when you need to: - Change a trigger's title, active status, position, or description - Modify the conditions that trigger the action - Update the actions the trigger performs - Reassign a trigger to a different category - Deactivate a trigger without deleting it This action is idempotent — re-running with the same parameters will produce the same result.

Update an existing trigger category in Zendesk. Trigger categories are used to organize ticket triggers in the Zendesk admin interface. Use this action when you need to: - Rename a trigger category - Change the display order of a trigger category - Update both name and position of a trigger category This action is idempotent — re-running with the same parameters will produce the same result.

Update a user identity in Zendesk. Use when you need to modify an identity's verified status or other updatable fields. Note: the 'primary' field cannot be changed via this endpoint - use the Make Identity Primary endpoint instead.

Update (replace) tags for a specific Zendesk user. Use when you need to assign or modify tags on a user account for organizing, filtering, or categorizing user data. This action replaces all existing tags on the user with the provided list.

Create or update a user profile for a specific Zendesk user by user ID and identifier. Use when you need to establish or modify a unified customer view for an existing Zendesk user. The profile is identified by both the user_id (path) and the identifier (query parameter). This endpoint uses PUT semantics - if a profile matching the identifier exists, it will be updated; otherwise, a new profile will be created. Use this action when you have a specific Zendesk user ID and need to create or update a profile using an identifier like email, phone number, or external ID.

Update an existing view in Zendesk. Views are saved searches that allow agents to filter and organize tickets. Use this action when you need to: - Change a view's title, description, or active status - Modify a view's position in the list - Update a view's conditions or display settings - Make a view the default view This action is idempotent — re-running with the same parameters will produce the same result.

Update Zendesk account-level settings including tickets, branding, localization, routing, and more. Use when you need to configure or modify account-wide settings that affect all agents and end users. Requires admin privileges to update most settings. Settings changes are persistent and affect all users.

Update an app installation in Zendesk. Use when you need to modify app installation settings such as enabling/disabling the app, restricting access by groups or roles, or updating app-specific settings.

Updates an attachment's malware access override setting. Use when you need to enable or restrict agent access to attachments that have been flagged for malware.

Update an organization in Zendesk. After updating, re-fetch via ZENDESK_GET_ZENDESK_ORGANIZATION if downstream logic depends on current data.

Update an existing target in Zendesk. Targets are endpoints that receive data when triggers fire (e.g., HTTP targets, email targets, webhook targets). Use this action when you need to: - Change a target's title - Activate or deactivate a target - Update target-specific properties This action is idempotent — re-running with the same parameters will produce the same result.

Tool to update a ticket in Zendesk. Use when you need to modify ticket fields like status, priority, or subject after confirming the ticket ID.

Update tags on a Zendesk ticket via PUT request to /api/v2/tickets/{ticket_id}/tags. Use when you need to add, replace, or manage tags on an existing ticket. This operation replaces all existing tags with the provided list.

Update an existing user field in Zendesk. Use when you need to modify the title, description, options, or other properties of a custom user field. Supports updating text, checkbox, dropdown, multiselect, date, integer, decimal, regexp validation, and lookup types. Only administrators can update user fields.

Partially updates a user profile in Zendesk by identifier. Use when you need to modify specific fields of an existing profile without replacing the entire profile. This action uses JSON merge patch semantics — only provided fields are updated. Use this action when you have an existing profile identifier and need to update specific profile attributes, identifiers, or the profile name. The identifier must follow the format source:type:identifier_type:identifier_value.

Partially updates a user profile in Zendesk by profile ID. Use when you need to modify specific fields of an existing profile without replacing the entire profile. This action uses JSON merge patch semantics — only provided fields are updated. Use this action when you have a profile ID and need to update specific profile attributes, identifiers, name, source, or type. This is different from UpdateUserProfile which uses identifier lookup instead.

Upload a file attachment to Zendesk. Returns an attachment object with an ID that can be used to attach the file to a ticket comment. Use when you need to add files (documents, images, logs, etc.) to Zendesk tickets. The upload token returned is valid for 60 minutes. After uploading, attach the file to a ticket by including the attachment token in your ticket comment.

Create or update a custom object record in Zendesk by external_id or name. Use when you need to create a new record or update an existing one based on either its external_id (preferred) or name. If a record matching the external_id or name exists, it will be updated. If no matching record is found, a new one will be created. This action is idempotent and safe to retry. Note: Either external_id or name (or both) must be provided to identify the record. If both are provided, external_id takes precedence for matching.

Verify if a subdomain name is available for use in Zendesk. Returns a success boolean indicating whether the subdomain can be registered. Use when checking if a desired subdomain name is available before creating a new Zendesk account or subdomain.

Verify a support address forwarding in Zendesk. This action sends a verification request for the specified support address to confirm that the address is properly configured and can receive email forwarding. Use this action when you need to: - Verify a newly created support address is working correctly - Re-verify an existing support address after configuration changes - Confirm email forwarding is properly set up for a support address This action is idempotent — verifying an already-verified address will return success.

Set a user identity as verified in Zendesk. This action marks an email address or other identity as confirmed, indicating the user has proven ownership. Use when you need to manually verify a user's identity after they have completed an out-of-band verification process or when you want to override the verification status for administrative purposes. Note: This action cannot verify the account owner's email identity due to security restrictions.