Zendesk

Zendesk Automations API

The Automations API from Zendesk — 6 operation(s) for automations.

Documentation GitHub OpenAPI

Operations 9

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /api/v2/automations List automations · Zendesk Get Api V2 Automations #

Ask an LLM

“What automations are set up in my Zendesk account?”

“Can I filter the automations list with optional parameters?”

Tell an agent

List all automations.

Show every automation in the account, active or inactive.

POST /api/v2/automations Create an automation · Zendesk Post Api V2 Automations #

Ask an LLM

“Can I create a time-based automation through the API?”

“What rules must a new automation's conditions follow?”

Tell an agent

Create an automation that closes tickets solved for 4 days.

Add a new automation with these conditions and actions.

GET /api/v2/automations/{automation_id} Get an automation · Zendesk Get Api V2 Automations Automation_id #

Ask an LLM

“How do I see the conditions and actions of a single automation?”

“Where can I look up one automation by id?”

Tell an agent

Show this automation.

Get one automation's conditions and actions.

PUT /api/v2/automations/{automation_id} Update an automation · Zendesk Put Api V2 Automations Automation_id #

Ask an LLM

“Can I change the conditions of an existing automation?”

“Is it possible to deactivate one automation?”

Tell an agent

Update this automation to run after 48 hours instead.

Change the actions on an existing automation.

DELETE /api/v2/automations/{automation_id} Delete an automation · Zendesk Delete Api V2 Automations Automation_id #

Ask an LLM

“Can I delete a single automation?”

“Why might I be blocked from deleting a default automation?”

Tell an agent destructive · confirm first

Delete this automation.

Remove one automation I no longer need.

GET /api/v2/automations/active List active automations · Zendesk Get Api V2 Automations Active #

Ask an LLM

“Which automations are currently active?”

“Can I list only the automations that are switched on?”

Tell an agent

List only active automations.

Show the automations currently running.

DELETE /api/v2/automations/destroy_many Delete several automations at once · Zendesk Delete Api V2 Automations Destroy_many #

Ask an LLM

“Can I bulk delete a list of automations?”

“What happens to restricted default automations in a bulk delete?”

Tell an agent destructive · confirm first

Delete the automations {ids}.

Bulk remove these automations: {ids}.

GET /api/v2/automations/search Search automations · Zendesk Get Api V2 Automations Search #

Ask an LLM

“Can I search automations by title?”

“Is automation search limited to offset pagination?”

Tell an agent

Search automations for ones about pending tickets.

Find automations whose title matches a keyword.

PUT /api/v2/automations/update_many Update several automations at once · Zendesk Put Api V2 Automations Update_many #

Ask an LLM

“Can I reorder or activate many automations in one request?”

“Which automations get skipped in a bulk update?”

Tell an agent

Bulk update the positions of these automations.

Activate a batch of automations in one request.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/zendesk:zendesk-automations-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Zendesk Automations API
  version: '1.0'
  description: 'Operations tagged Automations across 2 of this provider''s published API definitions: automations-openapi-original.yml, search-openapi-original.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: Automations
paths:
  /api/v2/automations:
    get:
      operationId: ListAutomations
      tags:
      - Automations
      summary: Zendesk Get Api V2 Automations
      description: 'Lists all automations for the current account.


        #### Allowed For


        * Agents


        #### Available Parameters


        You can pass in any combination of the following optional filters:


        | Name | Type | Comment

        | ---------- | ------- | -------

        | active | boolean | Only active automations if true, inactive automations if false

        | sort_by | string | Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", or "usage_7d". Defaults to "position"

        | sort_order | string | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others


        #### Sideloads


        The following sideloads are supported. The usage sideloads are only supported on the Support Professional or Suite Growth plan or above.


        | Name | Will sideload

        | ---------------- | -------------

        | app_installation | The app installation that requires each automation, if present

        | permissions | The permissions for each automation

        | usage_1h | The number of times each automation has been used in the past hour

        | usage_24h | The number of times each automation has been used in the past day

        | usage_7d | The number of times each automation has been used in the past week

        | usage_30d | The number of times each automation has been used in the past thirty days


        #### Pagination


        - Cursor pagination (recommended)

        - Offset pagination


        See Pagination.


        Returns a maximum of 100 records per page.'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationsResponse'
              examples:
                default:
                  $ref: '#/components/examples/AutomationsResponseExample'
    post:
      operationId: CreateAutomation
      tags:
      - Automations
      summary: Zendesk Post Api V2 Automations
      description: 'Creates an automation.


        New automations must be unique and have at least one condition that is true only once or an action that nullifies at least one of the conditions. Active automations can have overlapping conditions but can''t be identical.


        The request must include the following conditions in the `all` array:


        - At least one time-based condition

        - At least one condition that checks one of the following fields: `status`, `type`, `group_id`, `assignee_id`, or `requester_id`.


        #### Allowed For


        * Agents'
      responses:
        '201':
          description: Created response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationResponse'
              examples:
                default:
                  $ref: '#/components/examples/AutomationCreateResponseExample'
  /api/v2/automations/{automation_id}:
    parameters:
    - $ref: '#/components/parameters/AutomationId'
    get:
      operationId: ShowAutomation
      tags:
      - Automations
      summary: Zendesk Get Api V2 Automations Automation_id
      description: '#### Allowed For


        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationResponse'
              examples:
                default:
                  $ref: '#/components/examples/AutomationResponseExample'
    put:
      operationId: UpdateAutomation
      tags:
      - Automations
      summary: Zendesk Put Api V2 Automations Automation_id
      description: 'Updates an automation.


        Updated automations must be unique and have at least one condition that is true only once or an action that nullifies at least one of the conditions. Active automations can have overlapping conditions but can''t be identical.


        The request must include the following conditions in the `all` array:

        - At least one time-based condition

        - At least one condition that checks one of the following fields: ''status'', ''type'', ''group_id'', ''assignee_id'', or ''requester_id''


        **Note**: Updating a condition or action updates both the `conditions` and `actions` arrays, clearing all existing values of both arrays. Include all your conditions and actions when updating any condition or action.

        **Note**: You might be restricted from updating some default automations.


        #### Allowed For


        * Agents'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationResponse'
              examples:
                default:
                  $ref: '#/components/examples/AutomationResponseExample'
    delete:
      operationId: DeleteAutomation
      tags:
      - Automations
      summary: Zendesk Delete Api V2 Automations Automation_id
      description: '**Note**: You might be restricted from deleting some default automations.


        #### Allowed For


        * Agents'
      responses:
        '204':
          description: No Content response
  /api/v2/automations/active:
    get:
      operationId: ListActiveAutomations
      tags:
      - Automations
      summary: Zendesk Get Api V2 Automations Active
      description: 'Lists all active automations.


        #### Allowed For


        * Agents


        #### Available Parameters


        You can pass in any combination of the following optional filters:


        | Name | Type | Comment

        | ---------- | ------ | -------

        | sort_by | string | Possible values are "alphabetical", "created_at", "updated_at", "usage_1h", "usage_24h", or "usage_7d". Defaults to "position"

        | sort_order | string | One of "asc" or "desc". Defaults to "asc" for alphabetical and position sort, "desc" for all others


        #### Sideloads


        The following sideloads are supported:


        | Name | Will sideload

        | ---------------- | -------------

        | app_installation | The app installation that requires each automation, if present

        | permissions | The permissions for each automation

        | usage_1h | The number of times each automation has been used in the past hour

        | usage_24h | The number of times each automation has been used in the past day

        | usage_7d | The number of times each automation has been used in the past week

        | usage_30d | The number of times each automation has been used in the past thirty days'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationsResponse'
              examples:
                default:
                  $ref: '#/components/examples/AutomationsResponseExample'
  /api/v2/automations/destroy_many:
    delete:
      operationId: BulkDeleteAutomations
      tags:
      - Automations
      summary: Zendesk Delete Api V2 Automations Destroy_many
      description: 'Deletes the automations corresponding to the provided comma-separated list of IDs.


        **Note**: You might be restricted from deleting some default automations. If included in a bulk deletion, the unrestricted automations will be deleted.


        #### Allowed For


        * Agents


        #### Request Parameters


        The DELETE request takes one parameter, an `ids` object that lists the automations to delete.


        | Name | Description

        | ---- | -----------

        | ids | The IDs of the automations to delete


        #### Example request


        ```js

        {

        "ids": "25,23,27,22"

        }

        ```'
      parameters:
      - name: ids
        in: query
        description: The IDs of the automations to delete
        schema:
          type: array
          items:
            type: integer
      responses:
        '204':
          description: No Content response
  /api/v2/automations/search:
    parameters:
    - $ref: '#/components/parameters/AutomationSearchQuery'
    - $ref: '#/components/parameters/AutomationActive'
    - $ref: '#/components/parameters/AutomationSortBy'
    - $ref: '#/components/parameters/AutomationSortOrder'
    - $ref: '#/components/parameters/AutomationInclude'
    get:
      operationId: SearchAutomations
      tags:
      - Automations
      summary: Zendesk Get Api V2 Automations Search
      description: '#### Pagination


        * Offset pagination only


        See Using Offset Pagination.


        #### Allowed For


        * Agents


        #### Sideloads


        The following sideloads are supported. For more information, see Side-loading.


        | Name | Will sideload

        | ---------------- | -------------

        | app_installation | The app installation that requires each automation, if present

        | permissions | The permissions for each automation

        | usage_1h | The number of times each automation has been used in the past hour

        | usage_24h | The number of times each automation has been used in the past day

        | usage_7d | The number of times each automation has been used in the past week

        | usage_30d | The number of times each automation has been used in the past thirty days'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationsResponse'
              examples:
                default:
                  $ref: '#/components/examples/AutomationsSearchResponseExample'
  /api/v2/automations/update_many:
    put:
      operationId: UpdateManyAutomations
      tags:
      - Automations
      summary: Zendesk Put Api V2 Automations Update_many
      description: '**Note**: You might be restricted from updating some default automations. If included in a bulk update, the unrestricted automations will be updated.


        #### Allowed For


        * Agents


        #### Request Parameters


        The PUT request expects an `automations` object that lists the automations to update.


        Each automation may have the following properties:


        | Name | Mandatory | Description

        | -------- | --------- | -----------

        | id | yes | The ID of the automation to update

        | position | no | The new position of the automation

        | active | no | The active status of the automation (true or false)


        #### Example Request


        ```js

        {

        "automations": [

        {"id": 25, "position": 3},

        {"id": 23, "position": 5},

        {"id": 27, "position": 9},

        {"id": 22, "position": 7}

        ]

        }

        ```'
      responses:
        '200':
          description: Success response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AutomationsResponse'
              examples:
                default:
                  $ref: '#/components/examples/AutomationsUpdateManyResponseExample'
components:
  schemas:
    AutomationResponse:
      type: object
      properties:
        automation:
          $ref: '#/components/schemas/AutomationObject'
    AutomationsResponse:
      type: object
      properties:
        automations:
          type: array
          items:
            $ref: '#/components/schemas/AutomationObject'
        count:
          type: integer
          readOnly: true
        next_page:
          type: string
          nullable: true
          readOnly: true
        previous_page:
          type: string
          nullable: true
          readOnly: true
x-refined-from:
- automations-openapi-original.yml
- search-openapi-original.yml

Zendesk Automations API

Operations 9

Documentation

Specifications

Schemas & Data

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification