List macros

Your macros with name, text and the actions each one runs.

GET https://cotlet.dev/api/v1/gorgias/macros

read

Returns macros in the order Gorgias lists them, with their reply text and actions such as add tags, set status, assign a team or set priority. Archived macros are included only when you ask. Every role can read the list.

Parameters

Parameters: list_macros
NameTypeDescription
query string string Words to search for in the macro name or text.
include_archived boolean boolean Default: false.
cursor string string Next page cursor from the previous call.

Request

cURL
curl https://cotlet.dev/api/v1/gorgias/macros \
  -H "Authorization: Bearer $COTLET_API_KEY"
Python
result = client.call("gorgias", "list_macros")
Node.js
const result = await cotlet.call('gorgias', 'list_macros');
CLI
cotlet call gorgias list_macros

Example response

JSON

{
  "macros": [
    {
      "macro_id": 3018,
      "name": "Order status",
      "actions": [
        "Add tags",
        "Set status"
      ],
      "archived": false,
      "preview": "Hi {{ticket.customer.firstname}}, your order is on its way..."
    }
  ],
  "next_cursor": null
}

Sign in once. Your agent does the rest.

Sign up and add the apps you need. Free 7-day trial with 2,000 credits, no card needed.