POST
Suppress an address from every message this store sends

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

Both keys are required and NEITHER IS DEFAULTED. A missing reason would otherwise be filed as a manual removal, and a spam complaint recorded as a manual removal disappears from the store's evidence that it stopped mailing when asked. 201 EVEN ON A REPEAT, and the body is the suppression NOW IN FORCE, which on a repeat is the row already on file rather than the one you described. Compare the reason and created_at you get back against what you sent if you need to know which happened. Branching the status on that would leak whether an address is suppressed to a key holding only the write grant.

email
string<email>
required

The address to suppress. It is stored VERBATIM, because this platform's send gate compares the stored address to the recipient exactly. Send it as your own system holds it rather than normalising first.

reason
enum<string>
required

Why the address must not be mailed. It is a compliance record rather than a label, and a value outside the enum is a 400 rather than being coerced.

Available options:
bounce,
complaint,
manual,
unsubscribe

Response

Created

data
object