POST
Send a campaign now

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

campaignId
string
required

Body

application/json

Takes no parameters, and an empty body is expected. IT MAILS REAL PEOPLE AND THERE IS NO UNSEND. The audience is whatever the targeted segment resolves to right now. The pass runs INLINE and is bounded, so completed false is an ordinary outcome on a large audience and means "call again or wait" rather than "something failed"; the status field says which of the three reasons applies. USE A FRESH Idempotency-Key ON EVERY CALL. A replayed key returns the stored response without re-running anything, so a retry after a timeout would report progress that did not happen. Nobody is double-mailed either way: the message spine is insert-wins idempotent per recipient.

Response

Success

data
object