POST
Suppress an address from cart-recovery mail

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

Records a suppression. 201 carries the suppression NOW IN FORCE, which on a repeat is the ORIGINAL row rather than the one you just described, so compare what comes back if you need to know which. THERE IS NO UNDO ON THIS API. Nothing here removes a suppression, because removing one re-enrols a person who explicitly asked to stop.

email
string
required

The address to suppress. Lowercased and trimmed before it is stored, so it will come back normalised whatever you send.

reason
enum<string>
required

Why the address is suppressed, and REQUIRED rather than defaulted. An unrecognised value is a 400 here, while the merchant's dashboard coerces one to "manual": that default is reasonable for a person typing in a form and a trap for a machine, because a misspelled or omitted "complaint" would file every complaint as a manual removal, the store's compliance export would report none, and nothing anywhere would say so. unsubscribe and complaint are the shopper's own decision and must be honoured everywhere; bounce is a delivery fact that may be revisited, and manual is the merchant's own entry.

Available options:
unsubscribe,
bounce,
complaint,
manual

Response

Created

data
object