POST
Unsubscribe an address on the merchant's authority

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

THE ROUTE TO USE FOR A SUPPRESSION SYNC. It takes no unsubscribe token, unlike the storefront's own unsubscribe, because a token proves the address's owner clicked a link in their inbox and an integration importing suppressions from another provider has no such proof. Your api key is the merchant's authority. IT IS NOT A DELETE, and that is the point. The row survives carrying status unsubscribed, which is the store's suppression record: the storefront signup form checks it. DELETE /api/v1/newsletter-subscribers destroys that record and lets the next footer signup re-add the same person. 404 subscriber_not_found when the address was never on this list, so you can tell a partial import from a completed one.

email
string
required

The address to suppress. Normalised before lookup, so casing and surrounding whitespace do not matter.

Response

Success

data
object