POST
Compose a draft broadcast

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.

Body

application/json

IT CREATES A DRAFT AND THERE IS NO SEND ROUTE ON THIS API. The merchant sends it from their dashboard. A send mails every subscribed address at once, spends the store's plan email allowance and cannot be recalled, which is not a decision an api key can carry consent for. status is refused by name rather than ignored, so an attempt to create one already sending is a 400 and not a campaign that never goes out.

subject
string
required

The email subject line. Required and non-blank: a broadcast without one cannot be sent, and finding that out at send time means finding it out from the dashboard.

body
string
required

The message body, HTML. The platform appends its own unsubscribe footer at send time, so do not add one; a send is refused outright when no unsubscribe mechanism is configured.

Response

Created

data
object