Skip to main content
Required scopes: support_config_read
String
Plain-text internal note the macro adds. Null adds none.
[String!]!
required
Names of the tags the macro adds when applied. A name with no matching tag in the store is skipped.
Files the macro attaches to a reply. Inline body images are part of bodyHtml and aren’t listed here.
String!
required
Reply body as plain text. A variable appears as its bare name, such as customer_first_name, and the app fills it in from the ticket when the macro is used. This field returns variables unfilled. Variable names: current_date, customer_first_name, customer_full_name, customer_last_name, customer_email, agent_first_name, agent_full_name, agent_last_name, recent_claim_created_date, recent_claim_processed_date, recent_claim_status, recent_order_date, recent_order_delivery_status, recent_order_fulfillment_status, recent_return_status, recent_order_price, recent_order_returned_date, recent_order_shipping_address, recent_order_shipping_date, recent_order_tracking_number, recent_order_tracking_url_link, recent_order_number, recent_return_created_date, recent_return_processed_date, store_name.
String!
required
Reply body as HTML, with the same unfilled variables, each as <span data-variable=“customer_first_name”>customer_first_name</span>. Inline images use signed links that expire after one hour; query again for fresh ones.
required
When the macro was created.
ID!
required
The id of this macro.
String!
required
Name shown in the macro picker. Unique within the store.
String
Email subject the macro sets on the thread. Null leaves it unchanged.
Status the macro sets when applied. Null leaves the status unchanged.
How long the ticket is snoozed. Set only when setsStatus is SNOOZED.