Macros API

Macros are customizable shortcuts that allow you to apply a set of actions to a ticket with just one step. For more information, see About Macros.

Get All Macros

GET https://<tenant_subdomain>.wixanswers.com/api/v1/macros/admin

Get all macros.

Macro Restrictions
The returned list includes all macros, regardless of any macro restrictions for this agent.
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/macros/admin
Response Example:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
[
  {
    "id":"abb79b61-790e-4965-a5c2-ff9895fe8f26",
    "name":"Website support request",
    "description":"Tag with article and saved reply",
    "actions":[
      {
        "articleIds":["abbba26b-9eb8-42c1-ab86-072570425ec9"],
        "type":104
      },
      {
        "savedReplyId":"abb57f2b-fe89-40cd-b1b6-1fa49fee1bfa",
        "type":106
      }
    ],
    "disabled":false,
    "creationDate":1581528089000,
    "lastUpdateDate":1581528089000,
  }
]

Get All Enabled Macros

GET https://<tenant_subdomain>.wixanswers.com/api/v1/macros

Get all enabled macros, only.

Macro Restrictions
The returned list does not include macros with a restriction for this agent (ones for which this agent is forbidden, or for which a list of agents are allowed and this agent is not one of them).
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/macros

Get Macro

GET https://<tenant_subdomain>.wixanswers.com/api/v1/macros/{macro GUID}
Get a macro by its ID.

Macro Restrictions
The macro is returned regardless of any macro restrictions for this agent.
Request Example:
1
GET https://<tenant_subdomain>.wixanswers.com/api/v1/macros/bd948e62-a3fd-4cf0-87f3-0ae7f3fa4920