Skip to main content
POST
Create a macro

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Body

application/json

Unlike most write endpoints, the macro body is sent at the top level rather than under a macro key.

name
string
required

The macro name.

Example:

"Send the shipping policy"

actions
object[]
required

The ordered steps. An unrecognised action_name fails the whole request with a 422.

visibility
enum<string>

Defaults to personal. An agent token is always forced to personal whatever it sends — only an administrator can create a global macro.

Available options:
global,
personal

Response

Success

Single-macro responses are wrapped in a payload key.

payload
object