Guides
Signup For Free

Zendesk Ticketing API Integration Vol.3

Suggest Edits

These are the list of integration use cases supported by Knit for Zendesk Ticketing API as part of the TICKETING category

Generate Secret for OAuth Client

  • ID: put_generate_secret_for_oauth_client
  • Operation: write
  • Entities: admin, oauth client
  • Summary: The Generate Secret for OAuth Client API allows administrators to generate a new secret for a specified OAuth client. The API requires the OAuth client ID as a path parameter and uses basic authentication with an email address and API token. Upon successful execution, it returns the details of the OAuth client, including the newly generated secret, company name, creation and update timestamps, description, identifier, name, redirect URIs, and associated user ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Make Comment Private

  • ID: put_make_comment_private
  • Operation: write
  • Entities: agent, ticket, comment
  • Summary: The 'Make Comment Private' API allows agents to mark a specific comment on a ticket as private. This is done by sending a PUT request to the endpoint '/api/v2/tickets/{ticket_id}/comments/{ticket_comment_id}/make_private'. The request requires the 'ticket_id' and 'ticket_comment_id' as path parameters, both of which are integers and mandatory. The request headers must include 'Content-Type' set to 'application/json' and an 'Authorization' header for basic authentication. The response returns a status of 200 OK with no content in the body, indicating that the comment has been successfully made private.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Make Identity Primary

  • ID: put_make_identity_primary
  • Operation: write
  • Entities: identity, user
  • Summary: The 'Make Identity Primary' API sets a specified user identity as the primary identity for a user. This operation is performed using a PUT request to the endpoint '/api/v2/users/{user_id}/identities/{user_identity_id}/make_primary'. The API requires the 'user_id' and 'user_identity_id' as path parameters. The request must include a 'Content-Type' header set to 'application/json'. The response returns a list of user identities, indicating which identity is now primary. This API is accessible to agents and verified end users, with end users only able to make a verified email identity primary.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Mark Ticket as Spam and Suspend Requester

  • ID: put_mark_ticket_as_spam_and_suspend_requester
  • Operation: write
  • Entities: agent, requester, ticket
  • Summary: This API endpoint allows agents to mark a ticket as spam and suspend the requester. It requires the ticket ID as a path parameter and uses basic authentication with an email and API token. The request body should be an empty JSON object. Upon successful execution, the API returns a 200 OK status with no content in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Merge End Users

  • ID: put_merge_end_users
  • Operation: write
  • Entities: agent, ticket, user
  • Summary: The 'Merge End Users' API allows admins or agents with permission to edit end users to merge one end user into another. The user to be merged is specified in the path parameter 'user_id', and the existing user into which the specified user will be merged is provided in the request body. The API requires the 'Content-Type' header to be set to 'application/json'. The user specified in the path parameter must be a requester on 10,000 or fewer tickets to be eligible for merging. The response returns the details of the merged user, including their id and name.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Recover Multiple Suspended Tickets

  • ID: put_recover_multiple_suspended_tickets
  • Operation: write
  • Entities: agent, admin, suspended ticket
  • Summary: The 'Recover Multiple Suspended Tickets' API allows admins and agents with appropriate permissions to recover multiple suspended tickets by providing a comma-separated list of ticket ids. The API accepts up to 100 ids in a single request. The response includes the recovery status for each ticket id, indicating whether the recovery was successful or failed. This API is accessible to admins and agents with permission to manage suspended tickets on Enterprise plans, and unrestricted agents on all other plans.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Recover Suspended Ticket

  • ID: put_recover_suspended_ticket
  • Operation: write
  • Entities: agent, role, suspended ticket
  • Summary: The Recover Suspended Ticket API allows admins and agents with appropriate permissions to recover a suspended ticket by its ID. The requester is set to the authenticated agent to prevent re-suspension. The API processes requests synchronously and returns a 200 status with a tickets array if successful, or a 422 status with a suspended_tickets array if there are failures. The path parameter 'id' is required to specify the suspended ticket to recover.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Redact Chat Comment

  • ID: put_redact_chat_comment
  • Operation: write
  • Entities: agent, chat comment, ticket
  • Summary: The 'Redact Chat Comment' API allows agents to permanently remove specific words or strings from a chat ticket's comment by wrapping the content to be redacted with tags. The API replaces the redacted content with the ▇ symbol. This API is applicable for chat tickets and requires the 'Agent Workspace' to be enabled for the account. The request requires a 'ticket_id' as a path parameter and a request body containing 'chat_id', 'text', and either 'chat_index' or 'message_id'. The response returns the details of the chat event with the redacted message.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Redact Chat Comment Attachment

  • ID: put_redact_chat_comment_attachment
  • Operation: write
  • Entities: agent, chat ticket, chat attachment
  • Summary: The 'Redact Chat Comment Attachment' API allows agents to permanently remove one or more chat attachments from a chat ticket. This API is applicable for chat tickets and requires the Agent Workspace to be enabled for the account. The API uses the PUT method and requires the 'ticket_id' as a path parameter. The request body must include the 'chat_id' and either 'chat_indexes' or 'message_ids' to specify which attachments to redact. The response returns the details of the redacted chat event, including the chat_id, history of redacted attachments, and visitor_id.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Redact Comment Attachment

  • ID: put_redact_comment_attachment
  • Operation: write
  • Entities: comment, ticket, attachment
  • Summary: The Redact Comment Attachment API allows you to permanently remove attachments from an existing comment on a ticket. This operation is irreversible and replaces the attachment with an empty 'redacted.txt' file. The API is accessible to admins, agents with specific permissions, and agents assigned to custom roles with redaction permissions. The API requires the ticket ID, comment ID, and attachment ID as path parameters. The request must include authentication headers. The response returns details of the redacted attachment, including its content type, URL, file name, ID, size, and API URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Redact String in Comment

  • ID: put_redact_string_in_comment
  • Operation: write
  • Entities: agent, ticket, comment
  • Summary: The 'Redact String in Comment' API allows agents to permanently remove specific words or strings from a ticket comment in Zendesk. The API requires the ticket ID and ticket comment ID as path parameters. The string to be redacted is specified in the request body under the 'text' property. The redaction replaces the specified string with the ▇ symbol. This operation is irreversible and cannot be undone. The API is only available to agents with the 'Agents can delete tickets' permission enabled. The response includes the redacted comment details, such as the author ID, comment ID, and the redacted plain body of the comment.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Redact Ticket Comment In Agent Workspace

  • ID: put_redact_ticket_comment_in_agent_workspace
  • Operation: write
  • Entities: agent, ticket, comment
  • Summary: The 'Redact Ticket Comment In Agent Workspace' API allows agents to permanently remove sensitive information from ticket comments by wrapping the content to be redacted in tags within the html_body. This API supports redaction of comments in closed and archived tickets, as well as formatted text. The redaction process is irreversible and permanently deletes the data from Zendesk servers. The API requires the ticket_comment_id as a path parameter and the ticket_id in the request body. The html_body and external_attachment_urls are optional fields in the request body. The response includes the updated comment with redacted content replaced by the ▇ symbol.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reorder Group SLA Policies

  • ID: put_reorder_group_sla_policies
  • Operation: write
  • Entities: group SLA policy, admin
  • Summary: The 'Reorder Group SLA Policies' API allows administrators to reorder Group SLA policies by specifying their IDs. The API endpoint is '/api/v2/group_slas/policies/reorder' and it uses the PUT method. The request can include a query parameter 'group_sla_policy_ids', which is an array of strings representing the IDs of the policies to reorder. The request body can also include the same 'group_sla_policy_ids'. The response for a successful request is a 200 OK status with a null body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reorder Organization Field

  • ID: put_reorder_organization_field
  • Operation: write
  • Entities: field, organization
  • Summary: The 'Reorder Organization Field' API allows admins to reorder organization fields by specifying an array of organization field IDs. The request is made using the PUT method to the endpoint '/api/v2/organization_fields/reorder'. The request must include a JSON body with the 'organization_field_ids' array, and the 'Content-Type' header must be set to 'application/json'. A successful response returns a 200 OK status with a null body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reorder SLA Policies

  • ID: put_reorder_sla_policies
  • Operation: write
  • Entities: sla policy
  • Summary: The 'Reorder SLA Policies' API allows admins to reorder SLA policies for accounts on the Support Professional or Suite Growth plan or above. The API endpoint is '/api/v2/slas/policies/reorder' and it uses the PUT method. The request can include an optional query parameter 'sla_policy_ids', which is an array of integers representing the IDs of the SLA policies to reorder. The request must include a 'Content-Type' header set to 'application/json'. A successful response returns a 200 OK status with a null body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reorder Ticket Fields

  • ID: put_reorder_ticket_fields
  • Operation: write
  • Entities: ticket field, admin
  • Summary: The 'Reorder Ticket Fields' API allows administrators to reorder ticket fields by specifying an array of ticket field IDs in the request payload. The specified IDs will be assigned to the first positions, and any missing IDs will be automatically assigned incremental positions. The request must include the 'Content-Type' header set to 'application/json'. A successful request returns a 200 OK status with a null response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reorder Ticket Forms

  • ID: put_reorder_ticket_forms
  • Operation: write
  • Entities: ticket form, admin
  • Summary: The 'Reorder Ticket Forms' API allows administrators to reorder ticket forms by specifying an array of ticket form IDs in the desired order. The request is made using the PUT method to the endpoint '/api/v2/ticket_forms/reorder'. The request must include a 'Content-Type' header set to 'application/json' and a body containing the 'ticket_form_ids' array. A successful response returns a 200 OK status with an empty body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reorder Ticket Triggers

  • ID: put_reorder_ticket_triggers
  • Operation: write
  • Entities: ticket trigger, account, category
  • Summary: The Reorder Ticket Triggers API allows agents to alter the firing order of ticket triggers in their Zendesk account. The API requires a PUT request to the /api/v2/triggers/reorder endpoint with a JSON body containing a 'trigger_ids' array that lists all ticket trigger IDs in the account. This array sets the new firing order. If any trigger ID is missing, the API will return a 404 Forbidden error. Additionally, reordering is not allowed if there is more than one ticket trigger category, in which case a LimitOneCategory error will be returned. The response includes details of the reordered trigger, such as its actions, active status, category ID, conditions, creation and update timestamps, description, ID, position, raw title, title, and URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reorder User Field

  • ID: put_reorder_user_field
  • Operation: write
  • Entities: field, admin, user
  • Summary: The 'Reorder User Field' API allows admins to reorder user fields by specifying an array of user field IDs in the desired order. The request is made using the PUT method to the endpoint '/api/v2/user_fields/reorder'. The request must include headers for 'Content-Type' as 'application/json' and 'Authorization' for basic authentication using an email and API token. The body of the request should contain 'user_field_ids', an array of integers representing the IDs of the user fields in the new order. A successful response returns a 200 OK status with a null body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Reorder Workspaces

  • ID: put_reorder_workspaces
  • Operation: write
  • Entities: admin, workspace
  • Summary: The Reorder Workspaces API allows administrators to reorder workspaces by specifying an array of workspace IDs in the desired order. The request is made using the PUT method to the endpoint /api/v2/workspaces/reorder. The request body must include a JSON object with an 'ids' array containing the workspace IDs. The Content-Type header must be set to 'application/json'. A successful request returns a 200 OK status with a null response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Request User Verification

  • ID: put_request_user_verification
  • Operation: write
  • Entities: agent, identity, user
  • Summary: The 'Request User Verification' API endpoint sends a verification email to the user to verify ownership of their email address. It is accessible to agents and requires the user ID and user identity ID as path parameters. The request must include a 'Content-Type' header set to 'application/json' and an 'Authorization' header with a basic authentication token. The request body should be an empty JSON object. A successful request returns a 200 OK status with no content in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Restore a Previously Deleted Ticket

  • ID: put_restore_previously_deleted_ticket
  • Operation: write
  • Entities: agent, ticket
  • Summary: This API endpoint allows agents to restore a previously deleted ticket by sending a PUT request to the specified URL. The request requires the 'ticket_id' as a path parameter, which is the ID of the ticket to be restored. The request must include an Authorization header with a basic authentication token. Upon successful restoration, the API returns a 200 OK status with no content in the response body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Restore Previously Deleted Tickets in Bulk

  • ID: put_restore_previously_deleted_tickets_in_bulk
  • Operation: write
  • Entities: agent, ticket
  • Summary: This API allows agents to restore previously deleted tickets in bulk. The request is made using the PUT method to the endpoint /api/v2/deleted_tickets/restore_many with a required query parameter 'ids', which is a comma-separated list of ticket ids to be restored. The request must include an Authorization header for basic authentication using an email and API token. A successful response returns a 200 OK status with a null body.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set Membership as Default

  • ID: put_set_membership_as_default
  • Operation: write
  • Entities: user, organization, organization membership
  • Summary: The 'Set Membership as Default' API allows admins and agents to set a specific organization membership as the default for a given user. This is done by sending a PUT request to the specified endpoint with the user ID and organization membership ID as path parameters. The request requires authentication via email/token and must include a Content-Type header set to 'application/json'. The response returns a list of organization memberships with details such as creation date, default status, organization ID, and user ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Set Organization as Default

  • ID: put_set_organization_as_default
  • Operation: write
  • Entities: user, organization, organization membership
  • Summary: The 'Set Organization as Default' API sets the default organization membership for a specified user. It requires the user ID and organization ID as path parameters. The request must include a Content-Type header set to 'application/json' and an Authorization header with a basic authentication token. The request body should be an empty JSON object. Upon success, it returns the organization membership details, including creation and update timestamps, the organization ID, user ID, and a boolean indicating if it is the default organization.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Brand

  • ID: put_update_a_brand
  • Operation: write
  • Entities: help center, logo, brand
  • Summary: The 'Update a Brand' API allows administrators to update the details of a brand, including its name, subdomain, host mapping, and active status. The API endpoint is '/api/v2/brands/{brand_id}' and requires a PUT request. The 'brand_id' is a required path parameter that specifies the brand to be updated. The request body can include optional fields such as 'active', 'host_mapping', 'name', and 'subdomain'. The API also supports updating a brand's image by uploading a local file. The response returns the updated brand details, including its URL, creation and update timestamps, logo details, and other attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Account Settings

  • ID: put_update_account_settings
  • Operation: write
  • Entities: setting, feature, account
  • Summary: The 'Update Account Settings' API allows administrators to update various settings for an account using a PUT request to the '/api/v2/account/settings' endpoint. The request must include a JSON body specifying the settings to be updated, such as 'active_features', 'agents', 'api', 'apps', and more. The response returns the updated settings in a JSON format, detailing the status of each feature and configuration. This API is intended for use by administrators to manage account configurations effectively.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update App

  • ID: put_update_app
  • Operation: write
  • Entities: app, admin, job
  • Summary: The Update App API allows admins to add a build of an existing app to the job queue by providing the app's ID and an upload ID for the app package. The app ID is required and can be obtained using the List Owned Apps endpoint. The upload ID specifies the uploaded app package to use for the build. The API returns a job ID which can be used to check the status of the build using the Get Job Status endpoint. The request must include the Content-Type header set to application/json and an Authorization header with a basic authentication token.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update App Installation

  • ID: put_update_app_installation
  • Operation: write
  • Entities: setting, app installation
  • Summary: The Update App Installation API allows administrators to update the settings of a specified app installation using its ID. The API requires the app installation ID as a path parameter and accepts a JSON body with the settings to be updated, such as the app name and API token. The request must include headers for content type and authorization. Upon successful update, the API returns detailed information about the app installation, including its ID, creation and update timestamps, settings, and other attributes.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Attachment for Malware

  • ID: put_update_attachment_for_malware
  • Operation: write
  • Entities: agent, attachment, admin
  • Summary: The 'Update Attachment for Malware' API allows administrators to toggle enabling or restricting agent access to attachments that have detected malware. The API requires the attachment ID as a path parameter and a JSON body specifying the 'malware_access_override' boolean to determine access permissions. The request must include a 'Content-Type' header set to 'application/json' and an 'Authorization' header for authentication. Upon successful execution, the API returns the updated attachment details, including content type, URL, file name, ID, size, and any thumbnails.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Automation

  • ID: put_update_automation
  • Operation: write
  • Entities: automation, condition, action
  • Summary: The Update Automation API allows agents to update an existing automation by specifying the automation ID in the path parameters. The request must include a JSON body with the updated automation details, such as the title. The automation must have unique conditions and actions, with at least one time-based condition and one condition checking specific fields like 'status', 'type', 'group_id', 'assignee_id', or 'requester_id'. The API requires the 'Content-Type' header to be set to 'application/json'. Upon successful update, the API returns a 200 OK status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Business Hours Schedule

  • ID: put_update_business_hours_schedule
  • Operation: write
  • Entities: business hour, admin, schedule
  • Summary: The Update Business Hours Schedule API allows admins to update an existing business hours schedule by specifying the schedule ID in the path parameters. The request must include the 'Content-Type' header set to 'application/json'. The request body can include optional fields such as 'name' and 'time_zone' to update the schedule details. The response returns the updated schedule details including the creation and update timestamps, schedule ID, intervals, name, and time zone.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Custom Role

  • ID: put_update_custom_role
  • Operation: write
  • Entities: agent, custom role, administrator
  • Summary: The Update Custom Role API allows administrators and agents with the manage_roles permission to update a custom agent role in Zendesk. This API is available for accounts on the Enterprise plan or above. The request requires the custom_role_id as a path parameter to identify the role to be updated. The request body must include the custom_role object with properties such as name, description, and configuration settings like chat_access and user_view_access. The response returns the updated custom role details, including configuration settings, timestamps, and role metadata.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Custom Ticket Status

  • ID: put_update_custom_ticket_status
  • Operation: write
  • Entities: custom status, ticket, admin
  • Summary: The Update Custom Ticket Status API allows administrators to update the properties of a custom ticket status by providing a custom_status object. The API requires the custom_status_id as a path parameter to identify which custom status to update. The request body can include properties such as active, agent_label, description, end_user_description, and end_user_label to specify the updates. The response returns the updated custom status details, including timestamps and status category.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Deletion Schedule

  • ID: put_update_deletion_schedule
  • Operation: write
  • Entities: condition, deletion schedule, admin
  • Summary: The Update Deletion Schedule API allows admins to update a deletion schedule by its ID. The API requires the deletion_schedule_id as a path parameter. The request body must include the deletion_schedule object, which can contain fields such as active, conditions, description, and title. The conditions field is an object with 'all' and 'any' arrays, where each condition specifies a field, operator, and value. The response returns the updated deletion schedule details, including its active status, conditions, description, title, and URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Dynamic Content Item

  • ID: put_update_dynamic_content_item
  • Operation: write
  • Entities: variant, dynamic content item
  • Summary: The Update Dynamic Content Item API allows admins and agents to update the name of a specific dynamic content item identified by its ID. The API uses the PUT method and requires the 'dynamic_content_item_id' as a path parameter. The request body must include the new name for the item. The response returns the updated item details, including its creation and update timestamps, default locale ID, name, placeholder, and associated variants with their respective details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Dynamic Content Variant

  • ID: put_update_dynamic_content_variant
  • Operation: write
  • Entities: variant, admin, dynamic content item
  • Summary: The Update Dynamic Content Variant API allows admins and agents to update a specific variant of a dynamic content item. The API endpoint requires the dynamic content item ID and the variant ID as path parameters. The request body can include properties such as 'active', 'default', and 'content' to update the variant. The response returns the updated variant details, including its active state, content, creation and update timestamps, and URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Group

  • ID: put_update_group
  • Operation: write
  • Entities: group, admin
  • Summary: The Update Group API allows admins to update the details of a specific group identified by the group_id. The request requires the group_id as a path parameter and the group name in the request body. The response returns the updated group details including the creation and last update timestamps, group ID, name, and public status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Group SLA Policy

  • ID: put_update_group_sla_policy
  • Operation: write
  • Entities: policy metric, group SLA policy, admin
  • Summary: The Update Group SLA Policy API allows administrators to update a specified Group SLA policy by providing the policy ID in the path parameters. The request requires a JSON body containing the updated details of the policy, including title, description, position, filter criteria, and policy metrics. The response returns the updated policy details, including its description, filter, ID, policy metrics, position, title, and URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Holiday

  • ID: put_update_holiday
  • Operation: write
  • Entities: business hour, holiday, schedule
  • Summary: The Update Holiday API allows admins to update the details of a holiday within a specific schedule. The API requires the schedule_id as a mandatory path parameter and optionally the holiday_id. The request body must include the holiday details such as name, start_date, and end_date. The response returns the updated holiday details including its ID, name, start date, and end date.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Intervals for a Schedule

  • ID: put_update_intervals_for_a_schedule
  • Operation: write
  • Entities: workweek, interval, schedule
  • Summary: The 'Update Intervals for a Schedule' API allows administrators to update the intervals for a specific schedule by providing the schedule ID in the path parameters. The request must include a JSON body with the workweek intervals, specifying the start and end times in minutes from midnight. The API returns the updated workweek intervals upon a successful request.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Macro

  • ID: put_update_macro
  • Operation: write
  • Entities: agent, action, macro
  • Summary: The Update Macro API allows agents to update an existing macro by specifying the macro ID in the path parameters. The request must include a JSON body with the macro details, including actions and title. When updating an action, all actions must be included as the array is replaced. The response returns the updated macro details, including actions, active status, description, ID, position, restrictions, and title.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Many Automations

  • ID: put_update_many_automations
  • Operation: write
  • Entities: agent, automation
  • Summary: The 'Update Many Automations' API allows agents to update multiple automations in bulk. The PUT request requires an 'automations' object containing a list of automations to update. Each automation must include an 'id' and may optionally include 'position' and 'active' status. The API endpoint is '/api/v2/automations/update_many'. Note that some default automations may be restricted from updates. The response returns a status of '200 OK' upon successful update.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Many Macros

  • ID: put_update_many_macros
  • Operation: write
  • Entities: agent, trigger, macro
  • Summary: The 'Update Many Macros' API allows agents to update multiple macros at once by specifying the changes in a macros object. Each macro in the request body must include the 'id' of the macro to update, and optionally, the 'position' and 'active' status. The API returns the count of updated macros and details of each updated macro, including actions, active status, description, id, position, restrictions, and title.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Many Organizations

  • ID: put_update_many_organizations
  • Operation: write
  • Entities: organization, job
  • Summary: The 'Update Many Organizations' API allows for bulk or batch updates of up to 100 organizations in Zendesk. It supports two modes: bulk update, where the same change is applied to multiple organizations, and batch update, where different changes can be applied to multiple organizations. The API accepts query parameters 'external_ids' and 'ids' for specifying organizations, and a request body containing either an 'organization' object for bulk updates or an 'organizations' array for batch updates. The response returns a 'job_status' JSON object indicating the status of the background job processing the updates. This API is accessible to admins and agents, with agents having restrictions on updating only the 'notes' field.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Many Ticket Triggers

  • ID: put_update_many_ticket_triggers
  • Operation: write
  • Entities: agent, ticket trigger, category
  • Summary: The 'Update Many Ticket Triggers' API allows agents to update the position or active status of multiple ticket triggers in Zendesk. The API accepts a PUT request with a JSON body containing a list of triggers to update. Each trigger must include an 'id' and may optionally include 'position', 'active', and 'category_id'. The response includes the count of updated triggers and details of each updated trigger, such as actions, conditions, and timestamps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Many Tickets

  • ID: put_update_many_tickets
  • Operation: write
  • Entities: ticket, tag, job_status
  • Summary: The Update Many Tickets API allows agents to update multiple tickets at once, either by making the same change to all tickets (bulk update) or different changes to each ticket (batch update). The API accepts up to 100 ticket objects or a comma-separated list of up to 100 ticket IDs. It returns a job_status JSON object and queues a background job to perform the updates. The API supports safe updates to prevent record update collisions. For bulk updates, you can specify properties like 'status', 'additional_tags', or 'remove_tags'. For batch updates, you provide an array of ticket objects with individual properties. The response includes the job status, progress, and results of the update actions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Many Users

  • ID: put_update_many_users
  • Operation: write
  • Entities: user, job status
  • Summary: The 'Update Many Users' API allows agents and administrators to perform bulk or batch updates on up to 100 users in Zendesk. Agents can update end users, while administrators can update end users, agents, and administrators. The API supports two types of updates: bulk updates, where the same change is applied to multiple users, and batch updates, where different changes are applied to multiple users. The request can include user IDs or external IDs as query parameters, and the request body must specify the changes to be made. The API returns a job_status JSON object, which queues a background job to perform the updates. The job status can be checked using the Show Job Status endpoint.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Many Variants

  • ID: put_update_many_variants
  • Operation: write
  • Entities: locale, variant, dynamic content item
  • Summary: The 'Update Many Variants' API allows admins and agents to update multiple variants of a dynamic content item by specifying their IDs in the request body. The API requires the 'dynamic_content_item_id' as a path parameter and a list of variants in the request body, each with its 'id', 'locale_id', 'active', 'default', and 'content'. The response returns the updated variants with details such as 'active', 'content', 'created_at', 'default', 'id', 'locale_id', 'outdated', 'updated_at', and 'url'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Many Views

  • ID: put_update_many_views
  • Operation: write
  • Entities: agent, view
  • Summary: The 'Update Many Views' API allows agents to update multiple views in a single request. The API endpoint is '/api/v2/views/update_many' and it uses the PUT method. The request body must include a 'views' object, which is an array of view objects to be updated. Each view object must have an 'id' (mandatory) and may include 'position' and 'active' properties. The response returns the updated views with details such as 'active' status, 'conditions', 'description', 'execution', 'id', 'position', 'restriction', and 'title'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update OAuth Client

  • ID: put_update_oauth_client
  • Operation: write
  • Entities: admin, oauth client
  • Summary: The Update OAuth Client API allows administrators to update the details of an existing OAuth client by specifying the client ID in the path parameters. The request must include a JSON body with the new name for the client. The response returns the updated client details, including company, creation and update timestamps, description, ID, identifier, name, redirect URIs, secret, URL, and associated user ID.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Organization

  • ID: put_update_organization
  • Operation: write
  • Entities: organization, note, domain_name
  • Summary: The Update Organization API allows admins and agents to update details of an organization identified by the organization_id. Agents with no permissions restrictions can only update the 'notes' field. The API requires a PUT request to the endpoint /api/v2/organizations/{organization_id} with the organization_id as a path parameter. The request body can include fields such as 'notes' to update the organization details. The response includes the updated organization details if successful, or an error message if too many requests are made.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Organization Field

  • ID: put_update_organization_field
  • Operation: write
  • Entities: field, option, organization
  • Summary: The Update Organization Field API allows administrators to update a dropdown or multiselect field for an organization. The API requires the organization_field_id as a path parameter. The request body must include an organization_field object with an array of custom_field_options, each containing an id, name, and value. All options must be passed on update; options not passed will be removed. The response includes details of the updated organization field, such as its active status, description, and timestamps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Profile by Profile ID

  • ID: put_update_profile_by_profile_id
  • Operation: write
  • Entities: agent, profile, identifier
  • Summary: The 'Update Profile by Profile ID' API allows agents to update a user profile specified by a profile ID. The profile must belong to a single user, and all identifiers must be associated with that user. The request body includes the profile details such as name, source, type, user ID, identifiers, and attributes. The 'source' field cannot be 'zendesk'. The response returns the updated profile details including attributes, identifiers, and timestamps for creation and last update. Access to this API depends on agent role permissions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Request

  • ID: put_update_request
  • Operation: write
  • Entities: comment, collaborator, request
  • Summary: The Update Request API allows end users to update a request by adding a comment, marking it as solved, or adding collaborators. The request ID is required as a path parameter. The request body can include a comment object, a boolean to mark the request as solved, and an array of additional collaborators. The response includes the updated request details such as custom status ID, description, ID, status, and subject.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Resource Collection

  • ID: put_update_resource_collection
  • Operation: write
  • Entities: payload, job status, resource collection
  • Summary: The Update Resource Collection API allows administrators to update a resource collection by providing a payload object similar to the content of a requirements.json file in a Zendesk app. The API requires the resource_collection_id as a path parameter and a JSON payload in the request body. The payload includes targets, such as an email target with properties like title, type, email, and subject. The response returns a job status object indicating the status of the resource update, including an ID, status, and a URL to check the job status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Routing Attribute

  • ID: put_update_routing_attribute
  • Operation: write
  • Entities: attribute, routing, admin
  • Summary: The Update Routing Attribute API allows administrators to update a skill-based routing attribute by specifying the attribute ID in the path parameters. The request must include the attribute's new name in the body and requires authentication via a basic token in the headers. The response returns the updated attribute details, including its creation and update timestamps, ID, name, and URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update a Sharing Agreement

  • ID: put_update_sharing_agreement
  • Operation: write
  • Entities: sharing agreement
  • Summary: The 'Update a Sharing Agreement' API allows admins to update the status of an existing sharing agreement by specifying the sharing agreement ID in the path parameters. The request must include a JSON body with the new status of the sharing agreement. The API returns the updated sharing agreement details, including its creation and update timestamps, name, partner name, remote subdomain, status, type, and URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Side Conversation

  • ID: put_update_side_conversation
  • Operation: write
  • Entities: agent, side conversation, ticket
  • Summary: The Update Side Conversation API allows agents to update the state or subject of a side conversation associated with a ticket. The API requires the ticket_id and side_conversation_id as path parameters. The request body should include a side_conversation object with optional properties 'state' and 'subject' to specify the updates. The state can be 'open' or 'closed'. The response typically includes the updated side conversation details.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update SLA Policy

  • ID: put_update_sla_policy
  • Operation: write
  • Entities: policy metric, sla policy, filter
  • Summary: The Update SLA Policy API allows administrators to update a specified SLA policy by providing the SLA policy ID in the path parameters. The request must include a JSON body with the SLA policy details such as title, description, position, filter criteria, and policy metrics. The response returns the updated SLA policy details including its ID, title, description, position, filter criteria, policy metrics, and URL. This API is available for accounts on the Support Professional or Suite Growth plan or above.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Support Address

  • ID: put_update_support_address
  • Operation: write
  • Entities: recipient address, account, support address
  • Summary: The Update Support Address API allows admins and agents with the appropriate permissions to update an existing support address for their account. The endpoint is accessed via a PUT request to /api/v2/recipient_addresses/{support_address_id}, where the support_address_id is a required path parameter indicating the ID of the support address to be updated. The request body must include a recipient_address object with a required name field. The API does not allow updating the email property of the support address. Upon a successful request, the API returns a 200 OK response with the updated recipient address details, including brand_id, created_at, default status, email, forwarding_status, id, name, and updated_at.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Target

  • ID: put_update_target
  • Operation: write
  • Entities: target
  • Summary: The Update Target API allows admins to update the details of a specific target identified by the target_id. The API requires the target_id as a path parameter and the email of the target in the request body. The request must include the Content-Type header set to application/json. Upon successful update, the API returns the updated target details including its active status, creation date, email, subject, title, and type.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Ticket

  • ID: put_update_ticket
  • Operation: write
  • Entities: audit event, ticket, comment
  • Summary: The Update Ticket API allows agents to update the details of a specific ticket by providing the ticket ID in the path parameters and a ticket object in the request body. The ticket object can include optional fields such as comment, custom_status_id, and status. The API generates an audit object in the response, detailing the changes made to the ticket. The response also includes rate limit information in the headers. This endpoint has specific rate limits, and exceeding them will result in a 429 Too Many Requests response.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Ticket Field Options

  • ID: put_update_ticket_field_options
  • Operation: write
  • Entities: option, ticket field, admin
  • Summary: The Update Ticket Field Options API allows administrators to update the options of a drop-down or multi-select custom field in a ticket field. The API requires the ticket_field_id as a path parameter and accepts a request body containing the custom_field_options attribute, which is an array of option objects. Each option object must include a name and value. Omitting an option from the request will remove it from the field. The API returns the updated ticket field details, including the custom field options. Rate limit information is provided in the response headers.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Ticket Form

  • ID: put_update_ticket_form
  • Operation: write
  • Entities: end user condition, ticket form, agent condition
  • Summary: The Update Ticket Form API allows admins to update an existing ticket form by specifying the ticket form ID in the path parameters. The request must include a JSON body with the ticket form details such as name, display name, and conditions for agents and end users. The response returns the updated ticket form details including its active status, creation and update timestamps, and associated ticket field IDs.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Ticket Form Status By Id

  • ID: put_update_ticket_form_status_by_id
  • Operation: write
  • Entities: ticket form, admin, status
  • Summary: The 'Update Ticket Form Status By Id' API allows admins to update or delete the association of a ticket form status by its ID. The API requires the 'ticket_form_id' and 'ticket_form_status_id' as path parameters. The request body should contain a list of 'custom_status_id' values to update. The response returns the updated list of ticket form statuses with their 'custom_status_id', 'id', and 'ticket_form_id'.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Ticket Trigger

  • ID: put_update_ticket_trigger
  • Operation: write
  • Entities: condition, action, trigger
  • Summary: The Update Ticket Trigger API allows agents to update an existing ticket trigger by specifying the trigger ID in the path. The request body must include the new trigger details, such as actions, category ID, conditions, and title. When updating a condition or action, both the conditions and actions arrays are cleared, so all conditions and actions must be included in the update. The response returns the updated trigger details, including its actions, active status, category ID, conditions, creation and update timestamps, description, ID, position, raw title, title, and URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update User

  • ID: put_update_user
  • Operation: write
  • Entities: phone number, email, user
  • Summary: The Update User API allows admins and agents with appropriate permissions to update user details such as name, email, phone number, suspension status, and profile image. The API supports adding a secondary email, verifying emails, suspending users, and updating profile images either by uploading a local file or using a remote URL. The endpoint has a rate limit of 5 requests per minute per unique user. The response includes rate limit information in the headers.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update User Field

  • ID: put_update_user_field
  • Operation: write
  • Entities: option, user field, organization
  • Summary: The Update User Field API allows administrators to update a dropdown or multiselect user field in Zendesk. The API requires the user_field_id as a path parameter to identify the specific user field to update. The request body must include the user_field object, which contains an array of custom_field_options for dropdown or multiselect fields. Each option must specify its id, name, and value. To create a new option, pass a null id. To update or reorder an option, include its id. To remove an option, omit it from the list. The response returns the updated user field details, including its active status, creation and update timestamps, description, and URL.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update User Identity

  • ID: put_update_user_identity
  • Operation: write
  • Entities: agent, identity, user
  • Summary: The Update User Identity API allows agents to update the specified identity of a user by setting it as verified or updating its value. The endpoint requires the user ID and user identity ID as path parameters. The request body can include the 'verified' boolean to set the identity as verified and/or the 'value' string to update the identity's value. The response returns the updated identity object with details such as creation and update timestamps, deliverability state, and verification status.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update View

  • ID: put_update_view
  • Operation: write
  • Entities: condition, view, restriction
  • Summary: The Update View API allows agents to update an existing view by specifying the view ID in the path parameter. The request body must include a view object with optional properties such as title, conditions (all and any), active status, output columns, and restriction details. The view object can specify conditions that tickets must meet to be included in the view. The response returns the updated view details, including its active status, conditions, description, execution details, ID, position, restriction, and title.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Update Workspace

  • ID: put_update_workspace
  • Operation: write
  • Entities: macro, condition, workspace
  • Summary: The Update Workspace API allows admins to update the details of a specific workspace identified by the workspace_id. The API requires the workspace_id as a path parameter and a JSON body containing the workspace details to be updated, such as conditions, description, macros, ticket_form_id, and title. The response includes the updated workspace details, including activation status, conditions, macros, and timestamps.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Verify Identity

  • ID: put_verify_identity
  • Operation: write
  • Entities: agent, identity, user
  • Summary: The Verify Identity API endpoint allows agents to set a specified user identity as verified. This endpoint is accessed via a PUT request to the URL /api/v2/users/{user_id}/identities/{user_identity_id}/verify. The request requires path parameters 'user_id' and 'user_identity_id' to specify the user and identity to verify. The request headers must include 'Content-Type' as 'application/json' and an 'Authorization' token for authentication. The request body is an empty JSON object. The response returns the identity details, including creation and update timestamps, identity type, and verification status. Note that this endpoint cannot be used to update the email identity of the account owner.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Verify Support Address Forwarding

  • ID: put_verify_support_address_forwarding
  • Operation: write
  • Entities: email forwarding, verification, support address
  • Summary: The Verify Support Address Forwarding API endpoint is used to send a test email to a specified support address to verify that email forwarding is correctly set up. This is necessary for external support addresses in Zendesk Support. The endpoint accepts a path parameter 'support_address_id' which is the ID of the support address to verify. The request body can specify the type of verification: 'forwarding', 'spf', or 'dns'. The default type is 'forwarding'. The API does not return the results of the test directly; instead, users should check the 'forwarding_status' property using the Show Support Address endpoint. This API is accessible to admins and agents with permission to manage channels and extensions.
  • Input Fields: Input Fields
  • Output Fields: Output Fields

Updated 1 day ago