DELETE
Erase a subscriber record

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

ERASURE, NOT UNSUBSCRIBE, and the two are not interchangeable. This removes the row entirely, including the record that the address once asked to stop, so the next storefront signup adds them back with nothing to say they had opted out. Use POST /api/v1/newsletter-subscribers/unsubscribe unless you are servicing an actual erasure request. NEEDS BOTH GRANTS. The qualified scope named above is refused to a key holding write_newsletter alone, so ask the merchant for both. THE ADDRESS IS IN THE BODY, unusually for a DELETE, and it has to be: the idempotency hash covers the method, the path and the body, and the path excludes the query string, so ?email= would hash identically for two different addresses under one Idempotency-Key and the second call would replay the first's 204 having erased nobody. IDEMPOTENCY HERE IS PER KEY, NOT PER ADDRESS. Replaying the same Idempotency-Key returns the stored 204 untouched. A FRESH key naming an address that is already gone is 404 subscriber_not_found, because an erasure you believe landed and an erasure that never happened are different facts.

email
string
required

The address to erase. Normalised before lookup.

Response

Success. The response has no body.