Macros

URL

/api/v2/objects/macros

Supported Parameters

  • macro_type - the type of macros you wish to view. Valid options are automatic, standard, button, system and integrated

Access

If authenticated with an account-token, you will receive all configured macros. If you are authenticated with a user-token, you will receive only macros you have access to execute.

Example JSON

[
    {
        "id": 3,
        "name": "Resolve",
        "macro_type": "button",
        "icon": 11,
        "enabled": true,
        "position": 1,
        "confirmation": "",
        "description": "Set the status to Resolved, set the assigned user to the currently logged in user, clear the reply due date and clear the resolution due date"
    },
    {
        "id": 4,
        "name": "Do something else",
        "macro_type": "button",
        "icon": 43,
        "enabled": true,
        "position": 2,
        "confirmation": "",
        "description": "Set the status to Waiting for Contact and decrease the priority"
    }
]

Proudly powered by Katapult. Running on 100% renewable energy.