Skip to main content
POST
Create / Update Email Template
Registers (or replaces) your app’s HTML override for a transactional email event. This is an upsert keyed by (store, app, event) — posting the same event again replaces the previous override. When enabled, your HTML is used in place of the platform default the next time that email is sent. Auth: OAuth access token with the write_email_templates scope. See Email template extensions for the supported event names and the template variables available to each.

Body Parameters

string
required
The transactional event this template overrides (e.g. order_confirmation, order_cancellation, shipment_notification, newsletter_welcome, abandoned_cart).
string
required
The HTML body to send for this event. May reference the event’s template variables.
string
Subject line override. Defaults to the platform subject for the event when omitted.
boolean
default:"true"
Whether the override is active. Set false to keep the row but fall back to the platform default at send time.

Request

Response

Errors