Zendesk

Zendesk Macros API

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

Documentation GitHub OpenAPI

Business capability

Operations 19

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/macros/{macro_id}/attachments List the attachments on a macro · Zendesk Get Api V2 Macros Macro_id Attachments #

Ask an LLM

“Which files are attached to one of my Zendesk macros?”

“Can I see the attachments a specific macro sends with its reply?”

Tell an agent

Show me the files attached to this macro.

List every attachment linked to the macro I'm editing.

POST /api/v2/macros/{macro_id}/attachments Upload an attachment directly to a macro · Zendesk Post Api V2 Macros Macro_id Attachments #

Ask an LLM

“Can I upload a file and attach it to an existing macro in one step?”

“What's the limit on how many attachments one macro can carry?”

Tell an agent

Upload this file and attach it straight to the macro I'm working on.

Add a new attachment to an existing macro in a single upload.

POST /api/v2/macros/attachments Upload a macro attachment to link later · Zendesk Post Api V2 Macros Attachments #

Ask an LLM

“Can I upload a macro attachment now and link it to a macro later?”

“What happens to uploaded macro attachments that never get linked to a macro?”

Tell an agent

Upload this file as a standalone macro attachment I'll link to a macro afterwards.

Stage an unlinked macro attachment upload for a macro I haven't created yet.

GET /api/v2/macros/attachments/{attachment_id} Get details of a macro attachment · Zendesk Get Api V2 Macros Attachments Attachment_id #

Ask an LLM

“What properties does a single macro attachment have, like its file name and size?”

“How can I look up one macro attachment by its id?”

Tell an agent

Show the details of this macro attachment.

Get the file name, size and URL of one specific macro attachment.

GET /api/v2/macros List all macros available to me · Zendesk Get Api V2 Macros #

Ask an LLM

“How do I get every shared and personal macro in my Zendesk account?”

“Do admins see other agents' personal macros when listing macros?”

Tell an agent

List all the macros I have access to, active or not.

Pull the full macro list for the account, including personal macros.

POST /api/v2/macros Create a macro · Zendesk Post Api V2 Macros #

Ask an LLM

“Can I create a new canned-response macro through the API?”

“What goes into a macro definition when I create one?”

Tell an agent

Create a new macro from this definition: {macro}.

Add a macro that sets status to pending and posts a reply.

GET /api/v2/macros/{macro_id} Get a single macro · Zendesk Get Api V2 Macros Macro_id #

Ask an LLM

“How can I see the actions and settings of one specific macro?”

“Where do I find a macro's title, actions and restrictions by id?”

Tell an agent

Show me the macro with this id and its actions.

Fetch the full definition of one macro.

PUT /api/v2/macros/{macro_id} Update a macro · Zendesk Put Api V2 Macros Macro_id #

Ask an LLM

“Can I change the actions or title of a macro I already created?”

“Is it possible to deactivate one existing macro via the API?”

Tell an agent

Update this existing macro with {macro}.

Rename one of my macros and change what it does.

DELETE /api/v2/macros/{macro_id} Delete a macro · Zendesk Delete Api V2 Macros Macro_id #

Ask an LLM

“Can I permanently remove a single macro I no longer use?”

“Are there restrictions on which agents can delete a macro?”

Tell an agent destructive · confirm first

Delete this one macro.

Remove the outdated macro from the account.

GET /api/v2/macros/{macro_id}/apply Preview the field changes a macro makes · Zendesk Get Api V2 Macros Macro_id Apply #

Ask an LLM

“What would a macro change on a ticket, without actually applying it?”

“Can I get just the ticket fields a macro would set?”

Tell an agent

Show me the changes this macro would make, without touching any ticket.

Preview only the field updates a macro produces.

GET /api/v2/macros/actions List the actions macros support · Zendesk Get Api V2 Macros Actions #

Ask an LLM

“Which actions are available to use inside Zendesk macros?”

“What kinds of things can a macro do to a ticket?”

Tell an agent

List the supported macro actions.

Show all the action types I can put in a macro.

GET /api/v2/macros/active List active macros · Zendesk Get Api V2 Macros Active #

Ask an LLM

“How do I see only the macros that are currently active?”

“Which of my shared and personal macros are switched on right now?”

Tell an agent

List only the active macros available to me.

Show the macros agents can currently apply, skipping inactive ones.

GET /api/v2/macros/categories List macro categories · Zendesk Get Api V2 Macros Categories #

Ask an LLM

“What categories are my macros organized into?”

“Can I get the list of macro categories I have access to?”

Tell an agent

List all macro categories.

Show the categories used to group macros.

GET /api/v2/macros/definitions Get definitions of macro actions · Zendesk Get Api V2 Macros Definitions #

Ask an LLM

“What values can each macro action take, like the options for setting status?”

“Where do I find the title, type and allowed values of each macro action?”

Tell an agent

Get the definitions of every action a macro can perform.

Show the allowed values for each macro action type.

DELETE /api/v2/macros/destroy_many Delete several macros at once · Zendesk Delete Api V2 Macros Destroy_many #

Ask an LLM

“Can I bulk delete a batch of macros in a single request?”

“Is there a way to remove many macros by id at the same time?”

Tell an agent destructive · confirm first

Delete the macros with ids {ids}.

Bulk remove these macros: {ids}.

GET /api/v2/macros/new Build an unsaved macro from a ticket · Zendesk Get Api V2 Macros New #

Ask an LLM

“Can I generate a macro draft based on an existing ticket?”

“How can I turn what's on a ticket into a macro replica without saving it?”

Tell an agent

Build an unsaved macro replica from ticket {ticket_id}.

Derive a draft macro from the fields on ticket {ticket_id}.

GET /api/v2/macros/search Search macros · Zendesk Get Api V2 Macros Search #

Ask an LLM

“Can I search my macros by title to find the right one?”

“Is macro search paginated by offset only?”

Tell an agent

Search my macros for ones about refunds.

Find macros whose title matches a keyword.

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

Ask an LLM

“Can I change the position or active state of many macros in one call?”

“Is there a bulk update for macros?”

Tell an agent

Bulk update these macros with the changes I list.

Deactivate a batch of macros in a single request.

GET /api/v2/tickets/{ticket_id}/macros/{macro_id}/apply Preview a ticket after applying a macro · Zendesk Get Api V2 Tickets Ticket_id Macros Macro_id Apply #

Ask an LLM

“What would the whole ticket look like after a macro is applied to it?”

“Can I preview a macro on a real ticket without changing it?”

Tell an agent

Show ticket {ticket_id} as it would look after applying this macro.

Preview the full ticket object for {ticket_id} with the macro applied, without saving.

Zendesk Macros API

Operations 19

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