Zendesk
API integration

list_all_zendesk_users

List users in Zendesk. Returns up to 100 users per page with id, name, email, role, and created_at fields.

get_single_zendesk_user_by_id

Get information about a specific user in Zendesk. Requires id. Returns id, name, email, role, active status and other user details.

delete_a_zendesk_user_by_id

Delete user id in Zendesk. Requires id. Returns user.id, active, and deleted fields to confirm deletion.

update_a_zendesk_user_by_id

Update users id in Zendesk. Requires id. Response returns id, name, email, role, suspended, created_at, updated_at.

list_all_zendesk_tickets

List tickets in Zendesk. Returns id, subject, status, requester_id, and created_at for each ticket.

get_single_zendesk_ticket_by_id

Get ticket id in Zendesk. Requires id. Returns ticket fields: id, subject, status, priority, requester_id, assignee_id, created_at, updated_at.

create_a_zendesk_ticket

Create ticket in Zendesk. Requires comment in request body. Returns ticket.id as identifier, status for current state, subject for title, and created_at timestamp.

update_a_zendesk_ticket_by_id

Update ticket id in Zendesk. Requires id. Returns updated ticket with id, status, updated_at, and audit events.

delete_a_zendesk_ticket_by_id

Delete a specific ticket in Zendesk using id. Returns no content on success.

zendesk_tickets_count

Get an approximate count of tickets in Zendesk. Returns count in the response. If the count exceeds 100,000, it is updated every 24 hours.

list_all_zendesk_search

List search results in Zendesk. Requires query. Returns count, next_page, previous_page, and results with tickets, users, groups, or organizations.

list_all_zendesk_ticket_comments

List comments for a specific ticket in Zendesk using ticket_id. Returns id, author_id, body, created_at, content_url, and recording_url for each comment.

list_all_zendesk_audit_logs

List audit_logs in Zendesk. Requires admin privileges with audit log access. Returns id, action, actor_id, created_at, source_type and ip_address for each log.

get_single_zendesk_audit_log_by_id

Get audit_logs id in Zendesk. Requires id. Returns id, created_at, actor_id, action, and events describing the change.

list_all_zendesk_account_settings

Get account settings in Zendesk. Returns fields like locale, time_zone, and other account configuration details.

get_single_zendesk_attachment_by_id

Get attachment details in Zendesk using id. Requires id. Returns id, file_name, content_url, content_type, size, width, height, created_at and updated_at fields.

zendesk_attachments_download

Use this endpoint to download the file content of a Zendesk attachment. It returns the raw file associated with the attachment ID retrieved from the metadata endpoint.

create_a_zendesk_attachment

Create attachments filename Requires filename. Returns upload.token for further uploads and attachments array with id and content_url in Zendesk.

list_all_zendesk_custom_statuses

List custom-statuses in Zendesk. Returns id, name, status_category, active, and default fields for each custom ticket status.

get_single_zendesk_custom_status_by_id

Get custom status in Zendesk by id. Requires id. Returns id, name, status_category, and active.

create_a_zendesk_custom_status

Create a custom-statuses resource in Zendesk. Requires agent_label and status_category. Returns fields such as id, agent_label, active, status_category, and description in the response.

update_a_zendesk_custom_status_by_id

Update a specific custom-status in Zendesk using id. Returns fields such as id, active, agent_label, description, end_user_description, and end_user_label in the response.

list_all_zendesk_ticket_fields

List ticket fields in Zendesk. Returns id, type, title, visible_in_portal, required, and position for each field.

get_single_zendesk_ticket_field_by_id

Get ticket field id in Zendesk. Requires id. Returns ticket_field fields id, type, title, description, required, and active.

create_a_zendesk_ticket_field

Create ticket field in Zendesk. Tags must be unique across custom fields. Returns id, type, title and active in ticket_field.

update_a_zendesk_ticket_field_by_id

Update ticket-fields id in Zendesk. Returns id, type, title, and custom_field_options describing the updated field.

delete_a_zendesk_ticket_field_by_id

Delete ticket field by id in Zendesk. Requires id. Returns 204 No Content.

list_all_zendesk_user_fields

List user-fields in Zendesk. Returns id, key, title, type, position, and active for each user field.

get_single_zendesk_user_field_by_id

Get user-field id in Zendesk. Requires id. Returns id, key, type, and title fields.

create_a_zendesk_user_field

Create user field in Zendesk. Returns id, type, title, active, created_at, and updated_at for the new field.

update_a_zendesk_user_field_by_id

Update user field id in Zendesk. Returns user_field with id, key, type, title, active, position and custom_field_options. For dropdown or multiselect fields, include all custom_field_options; omitted options are removed.

delete_a_zendesk_user_field_by_id

Delete user-fields id in Zendesk. Requires id. Returns no content.

list_all_zendesk_incremental_export

List tickets updated since start_time in Zendesk. Requires start_time. Returns tickets array with id, updated_at, status, and pagination fields end_of_stream, after_cursor, before_cursor.

list_all_zendesk_groups

List groups by user_id in Zendesk. Returns each group's id, name, created_at, and updated_at fields.

get_single_zendesk_group_by_id

Get group id in Zendesk. Requires id. Returns id, name, created_at, and updated_at fields.

create_a_zendesk_group

Create a new group in Zendesk. Returns details of the created group including id, name, and other group properties.

update_a_zendesk_group_by_id

Update a group in Zendesk. Requires id. Returns the updated group's properties including group_id and related fields.

delete_a_zendesk_group_by_id

Delete a group in Zendesk. Requires id. Returns confirmation of deletion.

list_all_zendesk_deleted_users

List deleted users in Zendesk. Returns id, name, email, and phone for each deleted user; permanently deleted users have email and phone null and name 'Permanently Deleted User'.

list_all_zendesk_tags

List tags in Zendesk. Returns up to 20,000 of the most popular tags from the last 60 days with name and count fields.

create_a_zendesk_tag

Set tags for a ticket in Zendesk. Requires id. Returns updated tag information for the ticket.

zendesk_tags_count

Get an approximate count of tags in Zendesk. Returns value indicating the tag count and refreshed_at showing when the count was last updated. If count exceeds 100,000, value is limited and refreshed_at may be null until update completes.

list_all_zendesk_custom_roles

List custom roles in Zendesk. Returns id, name, role_type, created_at, and updated_at for each role.

get_single_zendesk_custom_role_by_id

Get custom role id in Zendesk. Requires id. Returns custom_role.id, custom_role.name, and custom_role.role_type in the response.

list_all_zendesk_ticket_metrices

List ticket metrics in Zendesk. Returns ticket_metrics array with id, ticket_id, created_at, updated_at and other timing metrics.

get_single_zendesk_ticket_metrice_by_id

Get ticket metric id in Zendesk. Requires id. Returns ticket_metric.id, ticket_id, created_at and other key fields.

list_all_zendesk_search_export

Get search-export results in Zendesk. Requires query. Returns results array with created_at and related object fields.

list_all_zendesk_incremental_ticket_export

List tickets changed since start_time in Zendesk. Requires start_time. Returns tickets[] with each ticket’s details plus end_time and next_page for further pagination.

list_all_zendesk_incremental_ticket_events_export

List ticket events in Zendesk starting from start_time. Requires start_time at least one minute in the past. Returns ticket_events array with ticket_id, child_events, via, comment_present, and comment_public for each event.

list_all_zendesk_organizations

List organizations in Zendesk. Returns organizations array with id, name, created_at and updated_at.

get_single_zendesk_organization_by_id

Get organization id in Zendesk. Requires id. Returns id, name, created_at, updated_at.

create_a_zendesk_organization

Create organization in Zendesk using a unique name. Returns organization id, name, and other key fields in the response. Beware of rare race conditions creating multiple organizations with identical names.

update_a_zendesk_organization_by_id

Update organization in Zendesk. Requires id. Returns organization fields including notes and domain_names in the response. Updating domain_names will overwrite existing values; submit a complete list to preserve previous domains.

delete_a_zendesk_organization_by_id

Delete an organization in Zendesk. Requires id. No content is returned in the response.

list_all_zendesk_passthrough

Retrieves a list of all passthrough requests made to Zendesk. Useful for auditing and debugging previous dynamic API calls.

create_a_zendesk_passthrough

Executes a passthrough GET request to a specific Zendesk API endpoint. Allows dynamic access to data not covered by standard endpoints.

list_all_zendesk_group_memberships

List group-memberships for a specific group in Zendesk using group_id. Returns group_memberships array with id, user_id, group_id, and created_at for each membership.

get_single_zendesk_group_membership_by_id

Get details about a specific group membership in Zendesk. Requires id (group membership id). Returns group_id, user_id, and related membership details in the response.

create_a_zendesk_group_membership

Create a group-membership in Zendesk. Returns group_membership fields such as id, url, user_id, and group_id in the response.

delete_a_zendesk_group_membership_by_id

Delete a group-membership in Zendesk using id and user_id. Immediately removes the user from the group and schedules a job to unassign all working tickets assigned to this user and group combination. Returns status of removal.

list_all_zendesk_brands

List brands in Zendesk. Returns id, name, subdomain, active fields for each brand.

get_single_zendesk_brand_by_id

Get details for a specific brand in Zendesk using id. Returns name, brand_id, and other brand information in the response.

create_a_zendesk_brand

Create a brand in Zendesk. Returned response includes key fields of the created brand such as name and subdomain.

update_a_zendesk_brand_by_id

Update a specific brand in Zendesk. Requires id. Returns active status, host_mapping, name, and subdomain fields in the response.

delete_a_zendesk_brand_by_id

Delete a brand in Zendesk. Requires id. No response content is returned.

list_all_zendesk_macros

List macros in Zendesk. For admins, includes personal and shared macros across the account. Returns id, title and active fields for each macro.

get_single_zendesk_macro_by_id

Get macro id in Zendesk. Requires id. Returns id, title, actions, active, position, description, created_at, updated_at.

create_a_zendesk_macro

Create a macro in Zendesk with specified actions and title. Requires actions and title. Returns the macro id, title, actions, and other macro details in the response.

update_a_zendesk_macro_by_id

Update a macro in Zendesk using id. Clears other actions unless included. Returns the updated macro, including id, actions, and title fields in the response.

delete_a_zendesk_macro_by_id

Delete a macro in Zendesk using id. Returns empty response on success.

list_all_zendesk_macros_definitions

List macro action definitions in Zendesk. Returns title, type, and possible values for each action.

list_all_zendesk_results_count

Get results-count in Zendesk using query. Requires query. Returns count indicating the number of items matching the query.

list_all_zendesk_triggers

List triggers in Zendesk. Returns triggers.id, title, active, created_at, and updated_at for each trigger.

get_single_zendesk_trigger_by_id

Get information about a specific trigger in Zendesk. Requires id. Returns details including the trigger's properties and via type value.

create_a_zendesk_trigger

Create a trigger in Zendesk. Requires actions, category_id, and conditions. Returns id, title, active, actions, category_id, conditions, created_at, and updated_at fields in the response.

update_a_zendesk_trigger_by_id

Update a specific trigger in Zendesk by id. All existing conditions and actions are replaced; include all desired values. Returns the updated trigger's id, actions, conditions, and category_id.

delete_a_zendesk_trigger_by_id

Delete a trigger in Zendesk using id. Removes the specified trigger. No response body is returned.

list_all_zendesk_ticket_forms

List ticket-forms. Requires no parameters. Accessible to admins or agents; end users only receive forms where end_user_visible is true. Returns id, name, end_user_visible, and active for each form.

get_single_zendesk_ticket_form_by_id

Get ticket form id in Zendesk. Requires id. Returns id, name, display_name, active, end_user_visible, created_at, and updated_at fields.

create_a_zendesk_ticket_form

Create ticket form in Zendesk. Returns id, name, active, end_user_visible, position, and other ticket_form details in the response.

update_a_zendesk_ticket_form_by_id

Update ticket form id in Zendesk. Returns id, name, active, and end_user_visible of the updated ticket form.

delete_a_zendesk_ticket_form_by_id

Delete a ticket form in Zendesk using id. Requires id. Returns no content.

list_all_zendesk_requests

List requests in Zendesk. Returns id (request identifier), subject (request title), status (current status), requester_id (user who submitted it) and created_at (creation timestamp) for each request.

get_single_zendesk_request_by_id

Get information about a specific request in Zendesk. Requires id. Returns fields such as requester, subject, status, and created_at in the response.

create_a_zendesk_request

Create request in Zendesk. Requires comment in the request body; requester is required for anonymous requests. Returns id, status, and created_at for the new request.

update_a_zendesk_request_by_id

Update a specific request in Zendesk. Requires id. Returns the updated request including fields such as id, status, requester_id, and the updated comment or collaborators.

create_a_zendesk_ticket_import

Create a ticket import in Zendesk. Returns ticket fields including assignee_id, comments (with author_id, created_at, value), description, requester_id, subject, and tags. Requires ticket data in request body.

zendesk_ticket_imports_bulk

Create ticket imports in Zendesk. Accepts up to 100 tickets per request and returns job_status object with id, url, status, progress, created_at, updated_at for tracking import progress.

list_all_zendesk_ticket_metric_events

List ticket metric events in Zendesk using start_time. Requires start_time. Returns up to 100 events per page, each with id, ticket_id, metric name, value, and event timestamp.

list_all_zendesk_ticket_activities

List ticket-activities in Zendesk. Returns activities, actors, and users arrays for the requesting agent from the last 30 days.

get_single_zendesk_ticket_activity_by_id

Get ticket activity id in Zendesk. Requires id. Returns id, created_at, actor, object, and related activity details.

zendesk_ticket_activities_count

Get ticket-activities count in Zendesk. Returns count.value (approximate number of ticket activities in the last 30 days affecting the requesting agent, capped at 100000 while updating) and count.refreshed_at (timestamp of last count update).

list_all_zendesk_ticket_skips

List ticket skips for a specific ticket and agent in Zendesk. Requires ticket_id and user_id. Returns id, ticket_id, user_id, and created_at for each skip.

list_all_zendesk_suspended_tickets

List suspended tickets in Zendesk. Returns id, subject, cause, created_at, author_email, and recipient for each ticket.

get_single_zendesk_suspended_ticket_by_id

Get suspended ticket by id in Zendesk. Requires id. Returns id, subject, and status for the suspended ticket.

delete_a_zendesk_suspended_ticket_by_id

Delete suspended ticket id in Zendesk. Requires id. No response body returned.

list_all_zendesk_email_notifications

List email notifications in Zendesk. Returns each notification’s id, ticket_id, comment_id, and created_at fields.

get_single_zendesk_email_notification_by_id

Get email notification by id in Zendesk. Requires id. Returns email_notification object with fields: id (notification identifier), ticket_id (associated ticket), subject (email subject), body (plain-text content), and created_at (creation timestamp).

list_all_zendesk_sharing_agreements

List sharing-agreements in Zendesk. Returns sharing_agreements with key information about sharing relationships.

get_single_zendesk_sharing_agreement_by_id

Get sharing agreement id in Zendesk. Requires id. Returns sharing_agreement.id, type, and created_at fields.

create_a_zendesk_sharing_agreement

Create sharing agreement in Zendesk. Returns id and agreement details of the new sharing agreement in the response.

update_a_zendesk_sharing_agreement_by_id

Update a sharing-agreements resource in Zendesk by id. Only the status field is allowed to be updated. Returns the updated sharing_agreement object including its status in the response.

delete_a_zendesk_sharing_agreement_by_id

Delete a sharing agreement in Zendesk. Requires id. No content is returned in the response.

list_all_zendesk_ticket_form_statuses

List all ticket form statuses in Zendesk. Returns ticket_form_statuses with details such as id, status, and related fields.

list_all_zendesk_ticket_conversation_logs

List conversation log events for a specific ticket in Zendesk. Requires id. Returns conversation_log_events with event details.

list_all_zendesk_user_identities

List identities for a specific user in Zendesk. Requires user_id. Returns id, type, value, verified, and primary for each identity.

get_single_zendesk_user_identity_by_id

Get user identity id for a specific user in Zendesk. Requires user_id and id. Returns id, type, value, verified, primary, created_at and updated_at fields.

create_a_zendesk_user_identity

Create a new user identity in Zendesk for the specified user_id. Returns the type and value of the created identity in the response.

update_a_zendesk_user_identity_by_id

Update a user identity in Zendesk using user_id and id. Returns id, user_id, verified, verification_method, primary, type, and value fields for the updated identity. Cannot modify the primary attribute.

delete_a_zendesk_user_identity_by_id

Delete user identity id for a specific user in Zendesk. Requires user_id and id. Returns identity.id and user_id of the deleted identity.

list_all_zendesk_user_events

List user-events for a specific user in Zendesk using user_id. Returns events with id, source, type, and created_at fields.

list_all_zendesk_organization_memberships

List organization-memberships in Zendesk. Returns organization_memberships with fields such as id, user_id, organization_id, and default status in the response.

get_single_zendesk_organization_membership_by_id

Get information about a specific organization membership in Zendesk. Requires id. Key fields in the response are returned for the organization membership.

create_a_zendesk_organization_membership

Create an organization-membership in Zendesk by assigning a user to an organization. Returns error 422 if the user is already assigned. Response includes the created membership's details.

delete_a_zendesk_organization_membership_by_id

Delete organization-memberships by id in Zendesk. Immediately removes a user from an organization and schedules unassignment of all working tickets associated with the user and organization. organization_id of related tickets is set to null.

list_all_zendesk_organization_fields

List organization fields in Zendesk. Returns a list of custom organization fields including key, title, and custom field settings. Fields are ordered as specified in the Zendesk Support configuration. No parameters required.

get_single_zendesk_organization_field_by_id

Get organization field in Zendesk. Requires id. Returns organization field details including name, type, and key response fields.

create_a_zendesk_organization_field

Create an organization field in Zendesk. Returns organization_field with details such as id, type, title, and custom field configuration.

update_a_zendesk_organization_field_by_id

Update organization field in Zendesk. Requires id. Returns organization_field fields including details of the updated organization field. When updating dropdown or multiselect fields, all options must be passed or they will be removed.

delete_a_zendesk_organization_field_by_id

Delete an organization field in Zendesk. Requires id. No content is returned in the response.

list_all_zendesk_organization_subscriptions

List organization-subscriptions in Zendesk. Returns up to 100 subscription records per page. Response includes all fields of listed organization-subscriptions.

get_single_zendesk_organization_subscription_by_id

Get a specific organization-subscriptions in Zendesk. Requires id. Returns the subscription details such as id, organization_id, and related subscription data.

create_a_zendesk_organization_subscription

Create an organization-subscription in Zendesk using organization_id and user_id. Returns the organization_subscription object with organization_id and user_id in the response.

delete_a_zendesk_organization_subscription_by_id

Delete an organization subscription in Zendesk. Requires id. No response content is returned on success.

list_all_zendesk_csat_survey_responses

List survey responses in Zendesk. Returns fields such as id, responder_id, subject_zrn, created_at, and response details for each survey response.

get_single_zendesk_csat_survey_response_by_id

Get information about a specific CSAT survey response in Zendesk. Requires locale and id. Returns survey response fields such as id, score, comment, and related survey information.

create_a_zendesk_csat_survey_response

Create a survey response in Zendesk. Returns survey_response fields including id, locale, responder_id, subject_zrns, and survey_id. The access_token in response links must be protected to prevent impersonation.

list_all_zendesk_csat_surveys

List CSAT surveys in Zendesk for a specific locale. Requires locale. Returns each survey's id, title, type, questions, and status in the response.

list_all_zendesk_satisfaction_ratings

List satisfaction ratings in Zendesk. Returns id, score, comment, created_at, and related user/ticket details for each rating.

get_single_zendesk_satisfaction_rating_by_id

Get a specific satisfaction rating in Zendesk. Requires id. Returns fields such as score, comment, user_id, and ticket_id in the response.

create_a_zendesk_satisfaction_rating

Create a satisfaction rating for a solved ticket in Zendesk. Requires ticket_id. The requester must be the verified end user. Returns the created satisfaction rating fields in the response.

list_all_zendesk_satisfaction_reasons

List all satisfaction-reasons in Zendesk. Returns id, reason, and position fields to identify and describe each satisfaction reason.

get_single_zendesk_satisfaction_reason_by_id

Get a specific satisfaction-reasons in Zendesk using id. Returns key fields such as id, reason, and translations for the requested satisfaction-reasons.

list_all_zendesk_job_statuses

List job statuses in Zendesk. Returns an array of job_statuses with key status information, sorted by completion and creation dates in descending order.

get_single_zendesk_job_status_by_id

Get job status in Zendesk. Requires id. Returns key job status fields such as status, total, progress, and any errors associated with the background job.

list_all_zendesk_dynamic_content_items

List all dynamic content items in Zendesk. Returns an array of items with key details such as id, name, and content for each item.

get_single_zendesk_dynamic_content_item_by_id

Get a dynamic content item in Zendesk. Requires id. Returns name, default_locale_id, variants, created_at, and updated_at fields in the response.

create_a_zendesk_dynamic_content_item

Create a new dynamic content item in Zendesk. Requires default_locale_id and at least one variant in the variants array. Returns the created item's id, variants, and other core fields.

update_a_zendesk_dynamic_content_item_by_id

Update the name of a specific dynamic content item in Zendesk. Requires id. Returns the updated item's id, name, default_locale_id, and created_at fields.

delete_a_zendesk_dynamic_content_item_by_id

Delete a dynamic-content-items resource in Zendesk. Requires id. Returns status indicating if the item was deleted.

list_all_zendesk_dynamic_content_item_variants

List all variants for a specific dynamic content item in Zendesk. Requires dynamic_content_item_id. Returns variant details including their properties in the response.

get_single_zendesk_dynamic_content_item_variant_by_id

Get a dynamic-content-item-variant in Zendesk. Requires dynamic_content_item_id and id. Returns key fields such as id, default, locale_id, and content for the variant.

create_a_zendesk_dynamic_content_item_variant

Create a dynamic content item variant in Zendesk for a specific dynamic_content_item_id. Only one variant per locale_id is allowed. Returns details including id, locale_id, and variant content.

update_a_zendesk_dynamic_content_item_variant_by_id

Update dynamic-content-item-variants in Zendesk. Requires dynamic_content_item_id and id. The response returns updated dynamic_content_variant fields. Cannot change active state or default flag of the default variant; make another variant default first.

delete_a_zendesk_dynamic_content_item_variant_by_id

Delete a dynamic content item variant in Zendesk. Requires dynamic_content_item_id and id. No content is returned in the response.

list_all_zendesk_schedules

List schedules in Zendesk. Returns information such as id, name, and time settings for each schedule.

get_single_zendesk_schedule_by_id

Get a specific schedule in Zendesk by id. Returns id, name, and business hours details in the response.

create_a_zendesk_schedule

List schedules in Zendesk. Returns fields such as id, name, time_zone, and intervals for each schedule.

update_a_zendesk_schedule_by_id

Update a schedule in Zendesk. Requires id. Returns schedule fields such as id, name, time_zone, and business hours in the response.

delete_a_zendesk_schedule_by_id

Delete a specific schedule in Zendesk. Requires id. No content is returned in the response.

list_all_zendesk_routing_attributes

List routing-attributes in Zendesk. Returns attributes for the account and includes attribute_values field in the response.

get_single_zendesk_routing_attribute_by_id

Get information about a specific routing attribute in Zendesk. Requires id. Returns fields such as id, name, and external_id in the response.

create_a_zendesk_routing_attribute

Create a routing-attributes resource in Zendesk. Returns key information about the newly created routing attribute, including its id, name, and configuration details.

update_a_zendesk_routing_attribute_by_id

Update routing-attributes in Zendesk. Requires id. Response includes routing_attribute fields such as name, type, and value.

delete_a_zendesk_routing_attribute_by_id

Delete a specific routing attribute in Zendesk. Requires id. No fields are returned in the response.

list_all_zendesk_resource_collections

List resource collections in Zendesk. Returns resource_collections with their details in the response.

get_single_zendesk_resource_collection_by_id

Get details of a specific resource-collections resource in Zendesk. Requires id. Returns resource_collection fields, including information about the collection and its attributes.

create_a_zendesk_resource_collection

Create a resource collection in Zendesk using a provided payload object. Returns details of the created resource collection, including its properties as specified in the payload.

update_a_zendesk_resource_collection_by_id

Update a resource collection in Zendesk using the provided payload object. Returns the updated resource collection fields in the response. Requires id.

delete_a_zendesk_resource_collection_by_id

Delete a specific resource collection in Zendesk. Requires id. Returns job_status fields with the status and tracking information for the deletion job in the response.

list_all_zendesk_workspaces

List workspaces in Zendesk. Returns id, title, and other key workspace details in the response.

get_single_zendesk_workspace_by_id

Get details of a specific workspace in Zendesk. Requires id. Returns fields such as name, description, and status of the workspace in the response.

create_a_zendesk_workspace

Create workspace in Zendesk. Returns id, title, description, ticket_form_id, macros, and conditions for the created workspace.

update_a_zendesk_workspace_by_id

Update workspace in Zendesk. Requires id. Returns updated workspace fields such as id, title, and status in the response.

delete_a_zendesk_workspace_by_id

Delete a workspace in Zendesk. Requires id. No content is returned in the response.

list_all_zendesk_bookmarks

List bookmarks in Zendesk. Returns id, url, and title fields for each bookmark in the response.

create_a_zendesk_bookmark

Create a bookmark in Zendesk. Requires ticket_id. Returns the created bookmark with its id and ticket_id fields.

delete_a_zendesk_bookmark_by_id

Delete a specific bookmark in Zendesk using id. Returns 200 OK if the bookmark with the specified id exists.

list_all_zendesk_views

List all shared and personal views available to the current user in Zendesk. Returns fields such as id, title, active, and other key view attributes.

get_single_zendesk_view_by_id

List views in Zendesk by ids. Requires ids. Returns each view's id, title, active status, position, and other key fields in the response.

create_a_zendesk_view

Create a view in Zendesk with a required title and at least one required condition in the all array (status, type, group_id, assignee_id, or requester_id). Returns id, title, active, description, and other view fields in the response.

update_a_zendesk_view_by_id

Update a specific view in Zendesk. Requires id. Returns the updated view fields including title, all, any, active, output, and restriction in the response. All properties are optional; updating conditions replaces existing arrays.

delete_a_zendesk_view_by_id

Delete a specific view in Zendesk using id. No response body is returned.

list_all_zendesk_ticket_trigger_categories

List ticket trigger categories in Zendesk. Returns trigger category fields such as id, name, and position in the response.

get_single_zendesk_ticket_trigger_category_by_id

Get details about a specific ticket trigger category in Zendesk. Requires id. Returns information such as the trigger category's metadata and configuration fields.

create_a_zendesk_ticket_trigger_category

Create a ticket trigger category in Zendesk. Returns name and position fields of the created category in the response.

update_a_zendesk_ticket_trigger_category_by_id

Update a ticket trigger category in Zendesk using id. Returns updated trigger_category fields such as name and position in the response.

delete_a_zendesk_ticket_trigger_category_by_id

Delete a ticket trigger category by id in Zendesk. id is required. The operation removes the category from your Zendesk account. No content is returned in the response.

list_all_zendesk_automations

List automations in Zendesk. Returns an array of automation objects including key fields such as id, title, and active status.

get_single_zendesk_automation_by_id

Get a specific automation in Zendesk. Requires id. Returns fields such as id, title, active, and conditions in the response.

create_a_zendesk_automation

Create automation in Zendesk. Requires at least one time-based condition and one condition on status, type, group_id, assignee_id, or requester_id. Returns id, title, active status, and automation conditions.

update_a_zendesk_automation_by_id

Update an automation in Zendesk. Requires id. The request must have at least one time-based condition and a condition for one of: 'status', 'type', 'group_id', 'assignee_id', or 'requester_id'. Updates clear all existing conditions and actions. Key response fields include id, title, conditions, and actions, indicating the automation's identity, description, current conditions, and actions.

delete_a_zendesk_automation_by_id

Delete automation in Zendesk. Requires id. Some default automations cannot be deleted. No response body is returned.

list_all_zendesk_sla_policies

List SLA policies in Zendesk. Returns the sla_policies array, each containing id, title, description, and relevant SLA policy details.

get_single_zendesk_sla_policy_by_id

Get details about a specific SLA policy in Zendesk. Requires id. Returns SLA policy fields such as policy name, conditions, and metric definitions.

create_a_zendesk_sla_policy

Create SLA policy in Zendesk. Returns the created SLA policy's name, description, and policy metrics in the response. Only available for accounts on the Support Professional or Suite Growth plan or above.

update_a_zendesk_sla_policy_by_id

Update an SLA policy in Zendesk. Requires id. Returns the updated policy details including id, title, and policy conditions.

delete_a_zendesk_sla_policy_by_id

Delete an SLA policy in Zendesk. Requires id. Returns confirmation of successful deletion.

list_all_zendesk_group_sla_policies

List group-sla-policies in Zendesk. Returns the list of policies, each containing key details such as policy id, name, description, and associated groups.

get_single_zendesk_group_sla_policy_by_id

Get a specific group SLA policy in Zendesk. Requires id. Returns information about the group SLA policy including key fields such as group_sla_policy_id and related policy details.

create_a_zendesk_group_sla_policy

Create a group SLA policy in Zendesk. Returns the created group_sla_policy object with fields defining the SLA policy.

update_a_zendesk_group_sla_policy_by_id

Update a group SLA policy in Zendesk. Requires id. Returns updated SLA policy fields.

delete_a_zendesk_group_sla_policy_by_id

Delete a specific group-sla-policies resource in Zendesk. Requires id. No response content is returned on success.

list_all_zendesk_deletion_schedules

List all deletion-schedules in Zendesk. Returns deletion_schedules including schedule details and associated data for managing automatic data deletion in the account.

get_single_zendesk_deletion_schedule_by_id

Get a deletion schedule by id in Zendesk. Returns key fields of the deletion schedule in the response.

create_a_zendesk_deletion_schedule

Create a deletion-schedule in Zendesk. Returns the created deletion_schedule with fields such as active, conditions, description, and title in the response.

update_a_zendesk_deletion_schedule_by_id

Update a deletion schedule in Zendesk. Requires id. Returns fields: active (status), all (conditions), description, and title in deletion_schedule. All conditions must be included; updating clears previous conditions.

delete_a_zendesk_deletion_schedule_by_id

Delete a deletion schedule in Zendesk by id. No content is returned in the response.

get_single_zendesk_setting_by_id

Get settings for an account in Zendesk. Returns key fields like time_zone, default_locale, and account-specific flags in the response.

update_a_zendesk_setting_by_id

Update settings in Zendesk. Returns the updated fields such as brand_name, subdomain, and active features in the response.

list_all_zendesk_support_addresses

List support-addresses in Zendesk. Returns recipient_addresses containing id, email, brand_id, and verification status for each support address.

get_single_zendesk_support_address_by_id

Get details about a specific support-address in Zendesk. Requires id. Returns fields such as id, email, and related information in the response.

create_a_zendesk_support_address

Create support address in Zendesk. Returns recipient_address with details such as id, email, and verification status. Email must be valid and set up for forwarding if external; verify forwarding after creation.

update_a_zendesk_support_address_by_id

Update support-addresses in Zendesk. Requires id. Does not allow updating the email property. Returns updated support address fields including id, name, and status.

delete_a_zendesk_support_address_by_id

Delete a specific support address in Zendesk. Requires id. No content is returned in the response.

list_all_zendesk_sessions

List sessions in Zendesk. Returns all account sessions if authenticated as an admin, otherwise returns only sessions for the current user. Key fields in the response include session id, user_id, and created_at.

get_single_zendesk_session_by_id

Get a specific session in Zendesk. Requires user_id and id. Returns session fields including id, created_at, and other session details.

delete_a_zendesk_session_by_id

Delete a session in Zendesk. Requires user_id and id. No response content is returned.

list_all_zendesk_brand_agents

List brand agent memberships in Zendesk. Returns brand agent fields such as id and related brand and agent information.

get_single_zendesk_brand_agent_by_id

Get details about a specific brand-agent membership in Zendesk. Requires id. Returns brand_agent fields including agent_id, brand_id, and agent's membership details.

list_all_zendesk_locales

List locales available in Zendesk account. Returns an array of locales with their details.

get_single_zendesk_locale_by_id

Get information about a specific locale in Zendesk. Requires id. Returns fields such as id, name, and locale details.

list_all_zendesk_access_logs

List access-logs in Zendesk. Returns access log entries including key fields such as id, created_at, ip_address, source, and user_id in the response.

list_all_zendesk_monitored_x_handles

List monitored X handles in Zendesk. Returns id, screen_name, and active fields for each handle.

get_single_zendesk_monitored_x_handle_by_id

Get details of a specific monitored X handle in Zendesk. Requires id. Returns fields such as active status, screen name, and related Twitter account information.

create_a_zendesk_monitored_x_handle

Create a ticket from a tweet for a specific monitored-x-handle in Zendesk. Requires id. Returns the created ticket fields and their details.

list_all_zendesk_public_ips

List Zendesk public-ips. Returns main public IP ingress and egress addresses. No parameters required. The response includes public_ips with the set of current addresses.

list_all_zendesk_apps

List all public apps in Zendesk Marketplace. Returns fields such as id, name, and installation details for each app.

get_single_zendesk_app_by_id

Get information about a specific app in Zendesk. Requires id. Returns fields such as name, short_description, author_id, version, and status.

create_a_zendesk_app

Create an app in Zendesk by providing upload_id in the payload. Returns job_id to check build status. Requires upload_id in request body. job_id in response identifies the created build job.

update_a_zendesk_app_by_id

Update an app in Zendesk. Requires id and upload_id. Returns job_id to check the status of the build.

delete_a_zendesk_app_by_id

Delete an app in Zendesk. Requires id. Removes the specified app from the My Apps page. No content returned in the response.

list_all_zendesk_location_installations

List location installations in Zendesk. Returns location_installation objects with fields such as app_id, app_installation_id, created_at, id, location, location_id, and updated_at.

list_all_zendesk_locations

List locations in Zendesk. Returns each location's id, name, and associated attributes in the response.

get_single_zendesk_location_by_id

Get details about a specific location in Zendesk. Requires id. Returns fields such as id, name, app_id, and other key app location information.

list_all_zendesk_targets

List all targets in Zendesk. Returns fields such as id, title, type, and active status for each target.

get_single_zendesk_target_by_id

Get details about a specific target in Zendesk. Requires id. Returns fields such as id, title, type, and active status in the response.

create_a_zendesk_target

Create a new target in Zendesk. Returns id, title, type, and active fields for the created target.

update_a_zendesk_target_by_id

Update an existing target in Zendesk. Requires id. Response returns the updated target's details, including key fields such as id, title, and active status.

delete_a_zendesk_target_by_id

Delete target in Zendesk by id. No content is returned in the response.

list_all_zendesk_target_failures

List target-failures in Zendesk. Returns key fields including id, target_id, created_at, subject, and error details for each failure.

get_single_zendesk_target_failure_by_id

Get a target-failure in Zendesk using id. Returns fields such as id, target_id, created_at, and error details in the response.

list_all_zendesk_side_conversations

List side conversations for a ticket in Zendesk. Requires ticket_id. Returns side conversation details including external_ids with targetTicketId indicating the child ticket's id when applicable.

get_single_zendesk_side_conversation_by_id

Get a specific side conversation in Zendesk. Requires ticket_id and id. Response includes external_ids.targetTicketId for child ticket information.

create_a_zendesk_side_conversation

Create a side conversation in Zendesk with ticket_id. Returns side conversation details including subject, body, to, external_ids, and attachment_ids in the response.

update_a_zendesk_side_conversation_by_id

Update side-conversation state or subject in Zendesk. Requires ticket_id and id. Returns fields such as created_at, external_ids, and id in the response.

list_all_zendesk_side_conversation_events

List side-conversation-events in Zendesk. Requires ticket_id and side_conversation_id. Returns events with details such as type, timestamp, and actor_id for each event.

list_all_zendesk_jira_links

List links for the current account in Zendesk. Returns link id, ticket_id, issue_id, and related fields in the response.

get_single_zendesk_jira_link_by_id

Get a specific jira-link in Zendesk. Requires id. Returns details about the jira-link, including all key fields describing the link.

create_a_zendesk_jira_link

Create a Jira link in Zendesk. Returns the created Jira link's id, Jira issue key, Zendesk ticket id, and other link details.

delete_a_zendesk_jira_link_by_id

Delete a specific jira-links resource in Zendesk. Requires id. Returns status indicating success of removal.

list_all_zendesk_help_center_articles

List all help-center-articles in Zendesk for a specific locale. Returns id, title, body, created_at, updated_at, and author_id for each article.

delete_a_zendesk_help_center_article_by_id

Delete a specific help-center-articles resource in Zendesk using id. This archives the article, which can only be restored through the Zendesk Help Center user interface. No response content is returned.

get_single_zendesk_help_center_article_by_id

Get a specific help-center-article in Zendesk. Requires id. Returns fields such as id, title, body, author_id, created_at, and updated_at.

create_a_zendesk_help_center_article

Create a help-center-article in Zendesk. Requires section_id. Returns id, title, body, locale, user_segment_id, and permission_group_id fields of the newly created article.

update_a_zendesk_help_center_article_by_id

Update article metadata in Zendesk by id. Does not update title, body, locale, or draft. Returns article with updated metadata including promotion status and sorting position.

list_all_zendesk_help_center_sections

List sections in Zendesk Help Center for a specific locale. Requires locale. Returns section id, name, description, category_id, created_at, updated_at, and position.

get_single_zendesk_help_center_section_by_id

Get details of a specific help-center-sections in Zendesk. Requires id. Returns section id, name, description, category_id, position, locale, and created_at/updated_at fields.

create_a_zendesk_help_center_section

Create a section in Zendesk Help Center under a specific category. Requires category_id, name, and locale. Returns id, name, description, locale, and position fields of the created section in the response.

update_a_zendesk_help_center_section_by_id

Update a specific help center section in Zendesk using id. Updates name, description, position, sorting, category_id, parent_section_id, and theme_template in the source locale. Returns section details including id, name, description, and position.

delete_a_zendesk_help_center_section_by_id

Delete a specific help-center-section in Zendesk. Requires id. All articles in the section will also be deleted. Returns confirmation of deletion.

list_all_zendesk_help_center_section_articles

List articles in a specific help center section in Zendesk. Requires locale and id. Returns article id, title, body, html_url, author_id, created_at, and updated_at fields.

create_a_zendesk_help_center_section_article

Create an article in Zendesk under a specific help center section. Requires section_id. Returns article fields including id, title, body, locale, user_segment_id, and permission_group_id.

get_single_zendesk_help_center_section_article_by_id

Get a specific help center section article in Zendesk. Requires locale and id. Returns fields like id, title, body, author_id, created_at, and updated_at.

update_a_zendesk_help_center_section_article_by_id

Update a specific help center section article in Zendesk. Requires id. This updates metadata fields like promotion status and position but does not modify translation properties such as title, body, locale, or draft. The response returns the article object with updated metadata.

delete_a_zendesk_help_center_section_article_by_id

Delete a specific help center article in Zendesk. Requires id. No fields are returned in the response.

list_all_zendesk_help_center_categories

List help center categories in Zendesk.Returns categories with fields like id, name, description, position, created_at, and updated_at that the user can view.

get_single_zendesk_help_center_category_by_id

Get details of a specific help-center-category in Zendesk. Requires id. Returns fields like id, name, description, locale, and outdated status.

create_a_zendesk_help_center_category

Create a new help-center-category in Zendesk. Requires name. Returns id, name, locale, and other category details in the response.

delete_a_zendesk_help_center_category_by_id

Delete a help-center category in Zendesk by id. Every section and all articles under the category will also be deleted. Requires id.

update_a_zendesk_help_center_category_by_id

Update a help-center-category in Zendesk using id. Only metadata like sorting position can be updated. Returns updated category fields including id, position, and other metadata.

list_all_zendesk_help_center_permission_groups

List help-center-permission-groups in Zendesk. Returns permission_groups with details about each group's configuration and access levels.

get_single_zendesk_help_center_permission_group_by_id

Get a specific help-center-permission-group in Zendesk by id. Returns fields including id and name for the permission group.

create_a_zendesk_help_center_permission_group

Create a help-center-permission-group in Zendesk. Returns id, name, built_in status, edit permissions, publish permissions, and updated_at timestamp.

update_a_zendesk_help_center_permission_group_by_id

Update a specific help-center-permission-group in Zendesk. Requires id. Returns permission_group with fields such as user_segment, name, edit, and publish to define access control.

delete_a_zendesk_help_center_permission_group_by_id

Delete a help-center-permission-group in Zendesk. Requires id. No content is returned in the response.

list_all_zendesk_help_center_user_segments

List help-center-user-segments in Zendesk. Returns user_segments with fields including id, name, and user_type.

get_single_zendesk_help_center_user_segment_by_id

Get a specific help-center-user-segment in Zendesk. Requires id. Returns fields such as id, name, and conditions that define the segment.

create_a_zendesk_help_center_user_segment

Create a help-center-user-segment in Zendesk. Returns fields like id, name, and permissions for the newly created segment.

update_a_zendesk_help_center_user_segment_by_id

Update a help center user segment in Zendesk using id. Returns user_segment with key details such as name, description, and conditions.

delete_a_zendesk_help_center_user_segment_by_id

Delete a help-center-user-segment in Zendesk. Requires id.

create_a_zendesk_help_center_user_image

Create image upload URL and token in Zendesk. Requires content_type and file_size in request body. Returns url for uploading the image and headers required for the PUT request, along with a token to create the image path.

zendesk_help_center_user_images_create_image_path

Create image path in Zendesk. Requires token and brand_id. Returns user_image object with path that can be used to display the uploaded image in a community post.

list_all_zendesk_help_center_medias

List help-center-medias in Zendesk. Returns medias with key fields such as id, url, and content type. Results may be filtered by name prefix and sorted by created, updated, or name.

get_single_zendesk_help_center_media_by_id

Get information about a specific help-center-media in Zendesk using id. Returns key details about the Guide Media object.

create_a_zendesk_help_center_media

Create a new guide media in Zendesk using asset_upload_id and filename. Returns id for creating article attachments and url for embedding directly in article translations.

delete_a_zendesk_help_center_media_by_id

Delete a specific help-center-media in Zendesk. Requires id. Returns confirmation of deletion.

update_a_zendesk_help_center_media_by_id

Update a specific help-center-media in Zendesk by replacing it with new data. Requires id. Returns updated media details including asset_upload_id and filename.

zendesk_help_center_medias_create_upload_url

Create upload URL for a guide-media object in Zendesk. Requires content_type and file_size in the request body. Returns upload_url, headers, and asset_upload_id to be used for uploading the media file and later creating the guide-media object.

list_all_zendesk_help_center_article_attachments

List attachments for a specific help center article in Zendesk. Requires article_id. Returns fields such as id, file_name, content_url, size, and content_type for each attachment.

create_a_zendesk_help_center_article_attachment

Create a new article attachment in Zendesk for a specific article. Requires article_id and guide_media_id. Returns article_attachment with id, file_name, content_url, and other metadata.

delete_a_zendesk_help_center_article_attachment_by_id

Delete a specific help center article attachment in Zendesk. Requires id of the attachment to remove it permanently. No content is returned in the response.

get_single_zendesk_help_center_article_attachment_by_id

Get details of a specific help-center-article-attachment in Zendesk using locale and id. Returns fields such as file_name, content_url, size, and content_type.

list_all_zendesk_article_block_attachments

List article block attachments in Zendesk using locale and article_id. Returns block attachments that are not inline with details such as id, file_name, and content_url.

list_all_zendesk_article_inline_attachments

List inline attachments for a specific article in Zendesk. Requires article_id. Returns attachment id, file_name, content_url, size, and other metadata.

list_all_zendesk_article_comments

List article-comments for a specific user in Zendesk. Requires id. Returns fields such as id, body, html_body, author_id, created_at, and updated_at of each comment.

get_single_zendesk_article_comment_by_id

Get details of a specific article comment in Zendesk. Requires locale, article_id, and id. Returns fields such as id, body, author_id, created_at, and updated_at.

create_a_zendesk_article_comment

Create a comment on a specific article in Zendesk using article_id. Returns the comment id, body, locale, author_id, created_at, and updated_at in the response.

update_a_zendesk_article_comment_by_id

Update article-comments in Zendesk using article_id and id. Returns comment fields including body, html_body, author_id, created_at, and updated_at.

delete_a_zendesk_article_comment_by_id

Delete a specific article-comment in Zendesk. Requires article_id and id. No response body is returned.

list_all_zendesk_articles_lables

List all labels in Zendesk articles. Returns label name, id, and usage data for each label.

get_single_zendesk_articles_lable_by_id

Get properties of a specific article label in Zendesk using locale and id. Returns fields such as name, id, and updated_at for the label.

create_a_zendesk_articles_lable

Create labels for a specific article in Zendesk. Requires id. Returns labels with id, name, and created_by information.

delete_a_zendesk_articles_lable_by_id

Delete a specific article label in Zendesk. Requires id. No content is returned in the response upon successful deletion.

create_a_zendesk_help_center_content_tag

Create a help-center-content-tag in Zendesk. Requires name. Returns content_tag with fields including id and name.

list_all_zendesk_help_center_content_tags

List help center content tags in Zendesk. Returns id and name for each content tag.

get_single_zendesk_help_center_content_tag_by_id

Get details of a specific help-center-content-tag in Zendesk by id. Returns fields like id, name, and description in the response.

delete_a_zendesk_help_center_content_tag_by_id

Delete a specific help-center-content-tag in Zendesk. Requires id. Returns confirmation of deletion.

update_a_zendesk_help_center_content_tag_by_id

Update a specific help-center-content-tag in Zendesk using id. Returns the updated tag details including key fields such as id, name, and related metadata.

list_all_zendesk_help_center_sessions

Get the Help Center session in Zendesk and return the CSRF token for the current session. This provides the token needed for secure Help Center interactions.

list_all_zendesk_help_center_translations

List translations for a specific article in Zendesk. Requires article_id. Returns translations with fields such as locale, draft, outdated, and title.

get_single_zendesk_help_center_translation_by_id

Get a specific help-center-translation in Zendesk. Requires article_id and id (locale). Returns locale, title, body, and other translation details.

create_a_zendesk_help_center_translation

Create a translation for an article in Zendesk. Requires article_id. Returns translation id, locale, title, body, and source_id.

update_a_zendesk_help_center_translation_by_id

Get a specific help-center-translation in Zendesk. Requires article_id and id (locale). Returns id, locale, title, and body of the translation.

delete_a_zendesk_help_center_translation_by_id

Delete a specific help-center-translation in Zendesk. Requires id. Translation cannot be deleted if it is the only translation for the source object.

list_all_zendesk_help_center_themes

List help center themes in Zendesk. Returns id, name, author, and other theme details.

get_single_zendesk_help_center_theme_by_id

Get details of a specific help-center-theme in Zendesk using id. Returns the theme object with key information about the theme.

delete_a_zendesk_help_center_theme_by_id

Delete a specific help-center-theme in Zendesk. Requires id. No content is returned in the response.

zendesk_help_center_themes_publish

Publish a specific help-center-theme in Zendesk. Requires id. Returns status confirming the theme has been published.

create_a_zendesk_theme_import_job

Create a theme import job in Zendesk. Requires brand_id and format in the request. Returns theme_id, upload.url, and upload.parameters needed to upload the theme ZIP file.

create_a_zendesk_theme_update_job

Create a theme update job in Zendesk. Requires theme_id, replace_settings, and format in the request body. Returns job id and attributes for tracking the update process.

create_a_zendesk_theme_export_job

Create a theme export job in Zendesk. Requires theme_id and format (zip). Returns download.url where the exported theme can be downloaded once the job completes.

list_all_zendesk_topics

List topics in Zendesk community. Returns id, name, html_url, and url for each topic.

get_single_zendesk_topic_by_id

Get details of a specific topic in Zendesk by id. Returns fields such as id, name, description, position, and follower_count.

create_a_zendesk_topic

Create a new topic in Zendesk. Returns the id, name, description, created_at, and other details of the created topic.

update_a_zendesk_topic_by_id

Update a topic in Zendesk. Requires id. Returns the updated topic with fields such as id and name.

delete_a_zendesk_topic_by_id

Delete a specific topic in Zendesk. Requires id. The response confirms whether the topic was successfully deleted.

list_all_zendesk_posts

List posts in Zendesk community. Returns posts with key fields including id, title, details, status, and author information.

get_single_zendesk_post_by_id

Get information about a specific post in Zendesk. Requires id. Returns post details including title, body, author_id, created_at, and updated_at.

create_a_zendesk_post

Create a new post in Zendesk. Returns id, title, details, author_id, topic_id, created_at, and updated_at in the response.

update_a_zendesk_post_by_id

Update a specific post in Zendesk. Requires id. Returns the updated post object with details such as title, body, author, and status.

delete_a_zendesk_post_by_id

Delete a specific post in Zendesk. Requires id. Returns confirmation of deletion.

list_all_zendesk_post_comments

List comments on a specific post in Zendesk. Requires post_id. Returns comment id, body, author information, creation time, and related metadata.

get_single_zendesk_post_comment_by_id

Get information about a specific post-comment in Zendesk. Requires post_id and id. Returns fields including id, body, author_id, created_at, and updated_at.

create_a_zendesk_post_comment

Create a comment on a specific post in Zendesk. Requires post_id. Returns the created comment with fields such as id, body, author_id, and created_at.

update_a_zendesk_post_comment_by_id

Update a specific post-comment in Zendesk. Requires post_id and id. Returns comment fields including its content, author, and metadata.

delete_a_zendesk_post_comment_by_id

Delete a specific post-comment in Zendesk. Requires post_id and id.

list_all_zendesk_topic_subscriptions

List subscriptions for a specific topic in Zendesk. Requires topic_id. Response returns subscriptions created by the requesting user including details of each subscription.

get_single_zendesk_topic_subscription_by_id

Get details about a specific topic-subscription in Zendesk. Requires topic_id and id. Returns fields showing the subscription the end user created for the topic.

create_a_zendesk_topic_subscription

Create a topic subscription in Zendesk. Requires topic_id. Returns a subscription object indicating the user is subscribed to the specified topic.

update_a_zendesk_topic_subscription_by_id

Update a specific topic-subscription in Zendesk. Requires topic_id and id. Returns updated subscription details such as subscription_id and user association.

delete_a_zendesk_topic_subscription_by_id

Delete a topic-subscription in Zendesk. Requires topic_id and id. This removes the subscription to the specified topic.

list_all_zendesk_post_subscriptions

List post subscriptions in Zendesk for a given post. Requires post_id. Returns subscriptions with user and subscription details.

get_single_zendesk_post_subscription_by_id

Get details of a specific post-subscription in Zendesk. Requires post_id and id. Response includes subscription details created by the requesting end user.

create_a_zendesk_post_subscription

Create a subscription for a post in Zendesk. Requires post_id. Returns the subscription object including subscription id, user_id, and post_id.

delete_a_zendesk_post_subscription_by_id

Delete a specific post subscription in Zendesk. Requires post_id and id. Removes the subscription associated with the given post.

list_all_zendesk_section_subscription

List section-subscriptions in Zendesk for a given section_id and locale. Returns subscriptions with details such as id, user_id, and creation timestamps for the requesting end-user.

get_single_zendesk_section_subscription_by_id

Get details of a specific section-subscription in Zendesk. Requires section_id and id. Returns fields such as id, user_id, and created_at for the subscription.

create_a_zendesk_section_subscription

Create a section-subscription in Zendesk. Requires section_id. Returns subscription id, user_id, and section_id indicating the created subscription.

delete_a_zendesk_section_subscription_by_id

Delete a section-subscription in Zendesk. Requires locale, section_id, and id. Returns confirmation of deletion.

list_all_zendesk_article_subscription

List article-subscriptions for a specific article in Zendesk. Requires article_id. Returns subscriptions with details about users subscribed to the article.

get_single_zendesk_article_subscription_by_id

Get information about a specific article-subscription in Zendesk. Requires locale, article_id, and id. Returns fields such as user details and subscription status.

create_a_zendesk_article_subscription

Create an article-subscription for a specific article in Zendesk. Requires article_id. Returns the subscription object including id, user_id, and article_id.

delete_a_zendesk_article_subscription_by_id

Delete an article-subscription in Zendesk. Requires article_id and id. Returns no content on success.

list_all_zendesk_user_subscription

List user subscriptions for a specific user in Zendesk. Requires user_id. Returns id, followed_id (user being followed), and follower_id (user doing the following).

list_all_zendesk_help_center_votes

List help-center-votes for a given user in Zendesk. Requires user_id. Response returns votes including details such as the item voted on and vote type.

get_single_zendesk_help_center_vote_by_id

Get details of a specific help-center-votes in Zendesk using id. Returns id, user_id of the voter, item_id being voted on, value of the vote, and creation details.

create_a_zendesk_help_center_vote

Create a vote for a specific help-center article in Zendesk. Requires article_id. Returns vote details including id, user_id, and created_at.

delete_a_zendesk_help_center_vote_by_id

Delete a specific help-center-votes resource in Zendesk. Requires id. No response body is returned.

list_all_zendesk_badges

List all badges in Zendesk. Returns badge details including id, name, and associated information.

get_single_zendesk_badge_by_id

Get information about a specific badge in Zendesk. Requires id. Returns fields such as name, description, and created_at to identify the badge and its details.

create_a_zendesk_badge

Create a badge in Zendesk. Requires badge_category_id, name, and description. Optionally include icon_upload_id for a badge icon. Returns id, name, description, badge_category_id, and icon_upload_id.

update_a_zendesk_badge_by_id

Update a badge in Zendesk using id. Returns badge fields including badge_category_id, name, description, and icon_upload_id. To remove an icon, set icon_upload_id to null.

delete_a_zendesk_badge_by_id

Delete a badge in Zendesk. Requires id. Deleting a badge also deletes all badge assignments related to the badge.

list_all_zendesk_badge_assignments

List badge assignments in Zendesk. Returns id, badge_id, user_id, and created_at for each assignment.

create_a_zendesk_badge_assignment

Create a badge assignment in Zendesk. Requires badge_id and user_id. Returns badge_assignment with assigned badge and user details.

delete_a_zendesk_badge_assignment_by_id

Delete a badge assignment in Zendesk by id. Requires id. Returns confirmation of deletion.

list_all_zendesk_badge_categories

List badge categories in Zendesk. Returns badge categories with fields like id, name, and description.

get_single_zendesk_badge_category_by_id

Get details about a specific badge category in Zendesk using id. Returns id, brand_id, name, slug, created_at, and updated_at fields.

create_a_zendesk_badge_category

Create a badge category in Zendesk. Requires brand_id. Returns badge_category with fields including id, brand_id, name, and slug.

delete_a_zendesk_badge_category_by_id

Delete a badge category in Zendesk by id. Badge categories can only be deleted if they do not contain any badges.

list_all_zendesk_account_custom_claims

List account custom claims in Zendesk. Returns account_custom_claims for the account and brand, including key claim details.

get_single_zendesk_account_custom_claim_by_id

Get details of a specific account custom claim in Zendesk using id. Returns the claim's properties including its unique identifiers and configuration.

create_a_zendesk_account_custom_claim

Create an account custom claim in Zendesk scoped by account and brand. Each account/brand pair can have up to 5 custom claims. Returns details of the created custom claim.

update_a_zendesk_account_custom_claim_by_id

Update an account custom claim in Zendesk. Requires id. Returns the updated account custom claim fields.

delete_a_zendesk_account_custom_claim_by_id

Delete an account custom claim in Zendesk. Requires id. Returns success status without content.

list_all_zendesk_redirect_rules

List redirect rules in Zendesk. Returns fields such as id, redirect_from, and redirect_to.

get_single_zendesk_redirect_rule_by_id

Get information about a specific redirect rule in Zendesk. Requires id. The response returns fields such as id, source_locale, source_url, target_locale, and target_url, which define the rule and its redirection behavior.

create_a_zendesk_redirect_rule

Create or update a redirect rule in Zendesk. Requires redirect_from, redirect_to, and redirect_status. Returns redirect_from (source URL), redirect_to (destination URL), and redirect_status (HTTP status).

delete_a_zendesk_redirect_rule_by_id

Delete a specific redirect rule in Zendesk. Requires id. No response body returned.