Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Zendesk Automations API

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

Zendesk Automations API is one of 150 APIs that Zendesk publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 2 JSON Schema definitions.

Tagged areas include Automations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

This API exposes 9 operations across 6 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version 1.0.

Requests are made against the base URL https://{subdomain}.zendesk.com.

9 operations 6 paths 2 schemas 2 DELETE4 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0
Base URL
https://{subdomain}.zendesk.com
Resource Areas
1

Paths & Operations 9

Across 6 paths, the API surfaces 9 operations — 2 DELETE, 4 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Automations 9
GET
/api/v2/automations
Zendesk Get Api V2 Automations
ListAutomations → 200
POST
/api/v2/automations
Zendesk Post Api V2 Automations
CreateAutomation → 201
GET
/api/v2/automations/{automation_id}
Zendesk Get Api V2 Automations Automationid
ShowAutomation 1 param → 200
PUT
/api/v2/automations/{automation_id}
Zendesk Put Api V2 Automations Automationid
UpdateAutomation 1 param → 200
DELETE
/api/v2/automations/{automation_id}
Zendesk Delete Api V2 Automations Automationid
DeleteAutomation 1 param → 204
GET
/api/v2/automations/active
Zendesk Get Api V2 Automations Active
ListActiveAutomations → 200
DELETE
/api/v2/automations/destroy_many
Zendesk Delete Api V2 Automations Destroymany
BulkDeleteAutomations 1 param → 204
GET
/api/v2/automations/search
Zendesk Get Api V2 Automations Search
SearchAutomations 5 params → 200
PUT
/api/v2/automations/update_many
Zendesk Put Api V2 Automations Updatemany
UpdateManyAutomations → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are AutomationsResponse (4 properties), AutomationResponse (1 property). Each schema is shown below with its type and property counts.

AutomationsResponse
object
4 properties
AutomationResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-automations-api-openapi.yml Raw ↑

Other APIs Zendesk publishes across the network.

Zendesk Help Center Articles API
Zendesk Help Center Sections API
Zendesk Help Center Categories API
Zendesk Help Center Translations API
Zendesk Help Center Article Attachments API
Zendesk Help Center Article Comments API
Zendesk Help Center Article Labels API
Zendesk Help Center Topics API
Zendesk Help Center Posts API
Zendesk Help Center Post Comments API
Zendesk Help Center Votes API
Zendesk Help Center Content Subscriptions API