Sign in

v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Macros

Retrieve a macro

get/api/macros/{id}

Path parameters

idinteger required

The ID of the macro to retrieve.

Response

The requested macro.

idinteger

ID of the macro.

external_idstring nullable

External ID of the macro in a foreign system. This field is not used by Gorgias, feel free to set it to your own value.

namestring

The name of the Macro. Tips: choose a name that can be easily searched.

intent'discount/request' | 'exchange/request' | 'exchange/status' | 'feedback' | 'order/damaged' | 'order/cancel' | 'order/change' | 'order/wrong' | 'other/no_reply' | 'other/question' | 'other/thanks' | 'product/recommendation' | 'product/question' | 'refund/request' | 'refund/status' | 'return/request' | 'return/status' | 'shipping/change' | 'shipping/delivery-issue' | 'shipping/policy' | 'shipping/status' | 'stock/request' | 'subscription/cancel' | 'subscription/change' nullable

The intention of the macro should be used for.

languagestring nullable

The language of the macro in ISO 639-1 format.

usageinteger

How many times the macro was applied on a ticket.

created_datetimestring date-time nullable

When the macro was created.

updated_datetimestring date-time nullable

When the macro was last updated.

archived_datetimestring date-time nullable

When the macro was archived.

uristring

URI of the macro

Example response

{
  "id": 23453,
  "external_id": "CUS-324512",
  "name": "Order status inquiry",
  "intent": "discount/request",
  "language": "en",
  "usage": 58392,
  "actions": [
    {
      "arguments": {
        "tags": "question, order-status"
      },
      "name": "addTags",
      "title": "add tags",
      "type": "user"
    },
    {
      "arguments": {
        "body_html": "<div>Hi {{ticket.customer.firstname}},</div><br><div>Your order has been delivered.</div>",
        "body_text": "Hi {{ticket.customer.firstname}},\n\nYour order has been delivered."
      },
      "name": "setResponseText",
      "title": "add tags",
      "type": "user"
    }
  ],
  "created_datetime": "2019-11-23T15:59:41.966927",
  "updated_datetime": "2020-01-30T11:04:34.345123",
  "archived_datetime": "2019-11-23T15:59:41.966927"
}