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 Macros API

The Macros API from Zendesk — 15 operation(s) for macros.

Zendesk Macros 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 Macros. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 2 JSON Schemas.

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

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

19 operations 15 paths 6 schemas 2 DELETE12 GET3 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 19

Across 15 paths, the API surfaces 19 operations — 2 DELETE, 12 GET, 3 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Macros 19
GET
/api/v2/macros/{macro_id}/attachments
Zendesk Get Api V2 Macros Macroid Attachments
ListMacroAttachments 1 param → 200
POST
/api/v2/macros/{macro_id}/attachments
Zendesk Post Api V2 Macros Macroid Attachments
CreateAssociatedMacroAttachment 1 param → 201
POST
/api/v2/macros/attachments
Zendesk Post Api V2 Macros Attachments
CreateMacroAttachment → 201
GET
/api/v2/macros/attachments/{attachment_id}
Zendesk Get Api V2 Macros Attachments Attachmentid
ShowMacroAttachment 1 param → 200
GET
/api/v2/macros
Zendesk Get Api V2 Macros
ListMacros 8 params → 200
POST
/api/v2/macros
Zendesk Post Api V2 Macros
CreateMacro body → 200
GET
/api/v2/macros/{macro_id}
Zendesk Get Api V2 Macros Macroid
ShowMacro 1 param → 200
PUT
/api/v2/macros/{macro_id}
Zendesk Put Api V2 Macros Macroid
UpdateMacro 1 param body → 200
DELETE
/api/v2/macros/{macro_id}
Zendesk Delete Api V2 Macros Macroid
DeleteMacro 1 param → 204
GET
/api/v2/macros/{macro_id}/apply
Zendesk Get Api V2 Macros Macroid Apply
ShowChangesToTicket 1 param → 200
GET
/api/v2/macros/actions
Zendesk Get Api V2 Macros Actions
ListMacrosActions → 200
GET
/api/v2/macros/active
Zendesk Get Api V2 Macros Active
ListActiveMacros 6 params → 200
GET
/api/v2/macros/categories
Zendesk Get Api V2 Macros Categories
ListMacroCategories → 200
GET
/api/v2/macros/definitions
Zendesk Get Api V2 Macros Definitions
ListMacroActionDefinitions → 200
DELETE
/api/v2/macros/destroy_many
Zendesk Delete Api V2 Macros Destroymany
DeleteManyMacros 1 param → 204
GET
/api/v2/macros/new
Zendesk Get Api V2 Macros New
ShowDerivedMacro 2 params → 200
GET
/api/v2/macros/search
Zendesk Get Api V2 Macros Search
SearchMacro 9 params → 200
PUT
/api/v2/macros/update_many
Zendesk Put Api V2 Macros Updatemany
UpdateManyMacros body → 200
GET
/api/v2/tickets/{ticket_id}/macros/{macro_id}/apply
Zendesk Get Api V2 Tickets Ticketid Macros Macroid Apply
ShowTicketAfterChanges 2 params → 200

Schemas 6

The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are MacroResponse (1 property), MacroApplyTicketResponse (1 property), MacroAttachmentResponse (1 property), MacroAttachmentsResponse (1 property). Each schema is shown below with its type and property counts.

MacroCategoriesResponse
object
1 property
MacroAttachmentsResponse
object
1 property
MacroAttachmentResponse
object
1 property
MacroApplyTicketResponse
object
1 property
MacrosResponse
object
MacroResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zendesk-macros-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