Skip to main content
Required scopes: marketing_templates_read, marketing_templates_write
​
String!
required
The content canvas background, as set under Email styles in the email builder.
​
DateTime!
required
When the template was created.
​
String!
required
The email background, as set under Email styles in the email builder.
​
ID!
required
The id of this template.
​
String!
required
The template’s legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
​
String
The default link color, as set under Email styles in the email builder. Null when the merchant left it unset.
​
String!
required
The merchant-facing name of the template.
​
EmailTemplatePreview
Render this template, to see what recipients get. Use a width of about 375 for a phone.Requires: marketing_templates_read
​
String
The preview text shown after the subject in an inbox. Null when the merchant left it unset.
​
[EmailTemplateSection!]!
required
The blocks that make up the email body, in order. Nested column children keep their own ids. A type this API version does not model field-by-field is returned as EmailTemplateUnknownSection.
​
[JSON!]!
required
sections with every field selected, as JSON: one element per root block, in order, with __typename and nested column children. Empty or unreadable stored sections are []. Edits go through operations.
​
String!
required
The subject line as authored, before per-recipient substitution. A subject containing {{ }} placeholders is filled in per customer at send time, and some sends prepend a prefix, so this is not necessarily the subject any one customer saw. Empty when the template has no subject of its own.
​
MarketingTrigger!
required
The trigger context this template is valid for. Immutable after create. UNKNOWN when the stored trigger is not modeled in this API version.
​
DateTime!
required
When the template was last edited. Templates stay editable after the campaigns that used them have finished, so compare this against a campaign’s finishedAt to tell whether the content here is still what that campaign actually sent.