support_config_read
Arguments
String
Forward pagination cursor — returns macros after it.
String
Backward pagination cursor — returns macros before it.
Int
Forward pagination: returns the first N macros (max 100, default 25). Use with
after; mutually exclusive with last/before.Int
Backward pagination: returns the last N macros (max 100, default 25). Use with
before; mutually exclusive with first/after.Which key to sort by (defaults to the first key, newest-first). Combine with
reverse to flip direction.Boolean
Reverses the sort direction selected by
orderBy (or its default).String
Case-insensitive substring match on the name.
Returns
required
A paginated list of SupportMacro items.
Show fields
Show fields
required
The list of edges (each a node plus its pagination
cursor).Show fields
Show fields
String!
required
Opaque cursor for this item; pass to
after/before to page from here.required
The item at this edge.
Show fields
Show fields
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.
required
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.
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.
required
The nodes in this page, without the edge/cursor wrapper — a convenience over
edges.Show fields
Show fields
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.
required
Files the macro attaches to a reply. Inline body images are part of bodyHtml and aren’t listed here.
Show fields
Show fields
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.
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.
Pagination metadata for the current page.
Show fields
Show fields
String
Cursor of the last edge in this page; pass to
after to page forward.Boolean!
required
Whether more items exist after this page (drives forward pagination with
first/after).Boolean!
required
Whether more items exist before this page (drives backward pagination with
last/before).String
Cursor of the first edge in this page; pass to
before to page backward.Example
query {
supportMacros(after: "...", before: "...", first: 10, last: 10, orderBy: CREATED_AT, reverse: true, search: "...") {
nodes {
addsInternalNote
addsTagNames
body
bodyHtml
createdAt
id
name
setsEmailSubject
# ...
}
pageInfo { hasNextPage endCursor }
}
}