Sirportly

Toggle Menu

Execute a macro

This method allows you to execute a macro on the specified ticket.

URL

/api/v2/tickets/macro

Access

This method can be accessed by account tokens and user tokens where the associated user has access to the tickets UI.

Supported Parameters

  • ticket - the reference of the ticket you wish to execute a macro on (required)
  • macro - the ID or name of the macro you wish to execute

Returned Data

Full ticket properties will be returned including the ticket properties after the macro has been updated.

Example JSON

The value returned as ticket will contain the full ticket properties (minus the updates) as shown on the tickets page. The updates array will contain any updates which were added by the macro - this may also be an empty array if no updates are  added.

{
    "ticket": {...},
    "macro": {
        "id": 4,
        "name": "Blah",
        "macro_type": "standard",
        "icon": 25,
        "enabled": true,
        "position": 1,
        "confirmation": "",
        "description": "Set the status to Waiting for Contact and add a reply"
    },
    "updates": [...]
}