PATCH
Update a notification template

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key
string
required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

templateId
string
required

Body

application/json

Every field is optional and an omitted one keeps its stored value. A present but EMPTY subject or body is refused rather than stored: it would render a blank message to the shopper. To stop using your own wording, set is_active false, which falls the event back to the platform default and is reversible. event_key is refused BY NAME rather than ignored. A template is looked up by (store, event, channel) on every send, so moving it would swap two events' copy with nothing to notice; create a template for the other event instead.

subject
string

text/template source. Parsed before it is stored.

body
string

html/template source. Parsed before it is stored.

is_active
boolean

false falls this event back to the platform default wording and is the REVERSIBLE alternative to deleting the template.

Response

Success

data
object