> ## Documentation Index
> Fetch the complete documentation index at: https://developers.redo.com/llms.txt
> Use this file to discover all available pages before exploring further.
# updateEmailTemplate
> Update template metadata and/or apply section operations. Returns null if no owned template matches the id. Pass `input`, `operations`, or both.
**Required scopes:** [`marketing_templates_write`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_write)
## Arguments
The template's `id`, or its `legacyId` from an earlier version of the Redo API.
UpdateEmailTemplateInput}>
Metadata fields to change.
Content canvas background from Email styles.
Email background from Email styles.
Default link color. Pass null to clear it.
The merchant-facing name of the template.
Inbox preview text. Pass null to clear it.
The authored subject line.
[EmailTemplateSectionOperation!]}>
Surgical section edits, applied in order.
EmailTemplateSectionInsertInput}>
Insert a new section.
Insert immediately after this section id. Column children are not valid anchors. Omit after, before, and parent to insert last but above the footer.
Insert immediately before this section id. Column children are not valid anchors.
EmailTemplateButtonSectionInput}>
Insert a button section.
EmailTemplateChromeDinoSectionInput}>
Insert a Chrome dinosaur section.
EmailTemplateColumnSectionInput}>
Insert a column layout. Pass `columns` for the complete child list, or omit it for empty slots (columnCount, default 2).
EmailTemplateDiscountSectionInput}>
Insert a discount section.
EmailTemplateFooterSectionInput}>
Insert a footer section.
EmailTemplateHeaderSectionInput}>
Insert a header section.
EmailTemplateHtmlSectionInput}>
Insert an HTML section.
EmailTemplateImageSectionInput}>
Insert an image section.
Deprecated. Do not send. Column children are a complete `columns` list; `parent` without this field still appends to an interactive-review success section.
EmailTemplateLineSectionInput}>
Insert a line section.
EmailTemplateMenuSectionInput}>
Insert a menu section.
An interactive-review id. Appends the inserted block to that review's success section. Cannot combine with after or before. Column children are not filled this way; pass `columns` on the column payload.
EmailTemplateProductsSectionInput}>
Insert a products section. The trigger must provide Cart Context. Not a column child. recommendedProductFilterId is a product filter id, or 00000000feedb10cfeedb10c when this trigger already carries products.
EmailTemplateQrCodeSectionInput}>
Insert a QR code section.
EmailTemplateScratchToRevealSectionInput}>
Insert a scratch-to-reveal section.
EmailTemplateShoppableProductsSectionInput}>
Insert a shoppable products section. The trigger must provide Cart Context. Not a column child. productFilterId is a product filter id.
EmailTemplateSocialsSectionInput}>
Insert a socials section.
EmailTemplateSpacerSectionInput}>
Insert a spacer section.
EmailTemplateSubscriptionAddToOrderSectionInput}>
Insert a subscription add-to-order section.
EmailTemplateSubscriptionSkipOrDelaySectionInput}>
Insert a skip-or-delay section.
EmailTemplateSubscriptionSwapProductSectionInput}>
Insert a subscription swap-product section.
EmailTemplateTableSectionInput}>
Insert a table section.
EmailTemplateTextSectionInput}>
Insert a text section.
EmailTemplateTrackableSummarySectionInput}>
Insert an order-summary section. The trigger must provide a Trackable Summary. Not a column child.
EmailTemplateTrackingInfoSectionInput}>
Insert a tracking-info section. The trigger must provide a Tracker. Not a column child.
EmailTemplateSectionMoveInput}>
Move a section.
Place immediately after this section id.
Place immediately before this section id.
The section to move.
EmailTemplateSectionRemoveInput}>
Remove a section.
The section's id (`blockId`).
EmailTemplateSectionUpdateInput}>
Patch an existing section.
EmailTemplateButtonSectionInput}>
Patch a button section.
EmailTemplateChromeDinoSectionInput}>
Patch a Chrome dinosaur section.
EmailTemplateColumnSectionInput}>
Patch column layout, or replace children with a complete `columns` list. Decreasing columnCount without columns is rejected if trailing slots still have sections.
EmailTemplateDiscountSectionInput}>
Patch a discount section.
EmailTemplateFooterSectionInput}>
Patch a footer section.
EmailTemplateHeaderSectionInput}>
Patch a header section.
EmailTemplateHtmlSectionInput}>
Patch an HTML section.
The section's id (`blockId`).
EmailTemplateImageSectionInput}>
Patch an image section.
EmailTemplateLineSectionInput}>
Patch a line section.
EmailTemplateMenuSectionInput}>
Patch a menu section.
EmailTemplateProductsSectionInput}>
Patch a products section.
EmailTemplateQrCodeSectionInput}>
Patch a QR code section.
EmailTemplateScratchToRevealSectionInput}>
Patch a scratch-to-reveal section.
EmailTemplateShoppableProductsSectionInput}>
Patch a shoppable products section.
EmailTemplateSocialsSectionInput}>
Patch a socials section.
EmailTemplateSpacerSectionInput}>
Patch a spacer section.
EmailTemplateSubscriptionAddToOrderSectionInput}>
Patch a subscription add-to-order section.
EmailTemplateSubscriptionSkipOrDelaySectionInput}>
Patch a skip-or-delay section.
EmailTemplateSubscriptionSwapProductSectionInput}>
Patch a subscription swap-product section.
EmailTemplateTableSectionInput}>
Patch a table section.
EmailTemplateTextSectionInput}>
Patch a text section.
EmailTemplateTrackableSummarySectionInput}>
Patch an order-summary section.
EmailTemplateTrackingInfoSectionInput}>
Patch a tracking-info section.
## Returns
EmailTemplate}>
The content of an email, as the merchant authored it.
The content canvas background, as set under Email styles in the email builder.
DateTime!} required>
When the template was created.
The email background, as set under Email styles in the email builder.
The id of this template.
The template's legacy Mongo ObjectId (24-char hex) from before the CockroachDB migration.
The default link color, as set under Email styles in the email builder. Null when the merchant left it unset.
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`](/docs/api-reference/v3/reference/scopes#scope-marketing_templates_read)
**Arguments**
Render with this recent event's data instead of sample data: a 24-character hex event id. A well-formed id that can't be found falls back to sample data.
Viewport width of the screenshot, 320-1200 pixels.
**Fields**
The screenshot's full height in pixels.
The rendered email HTML, as a recipient's client would receive it.
A link to a full-length PNG screenshot at the requested width. It expires after an hour.
The screenshot's width in pixels.
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.
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.
## Example
```graphql theme={null}
mutation {
updateEmailTemplate(id: "...", input: { ... }, operations: { ... }) {
contentBackgroundColor
createdAt
emailBackgroundColor
id
legacyId
linkColor
name
previewText
# ...
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.