Suppress a contact on the merchant's authority
Authorizations
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
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
Body
THE ROUTE TO USE FOR A SUPPRESSION SYNC. It takes no unsubscribe token, unlike the preference centre a recipient reaches from their inbox, because a token proves the recipient clicked a link and an integration importing complaints from an ESP has no such proof. Your api key is the merchant's authority, and the consent ledger records that: the row is written with source public_api and names the key that asked, so an audit can tell it from a recipient's own click. IT ONLY EVER SUPPRESSES. There is no re-subscribe on this API and no full replace of a contact's preferences. An api key is not evidence that a person opted in, and a replace echoing back a document read an hour ago would silently resurrect consent for someone who unsubscribed in between. Record a genuine opt-in at POST /api/v1/marketing-contacts/{marketingContactId}/consent, where the source and the disclosure text actually shown are yours to state. IDEMPOTENT WITHOUT A REPLAY. A channel already unsubscribed is a no-op that answers 200 and writes no second ledger row, so a nightly reconciler can run against the whole list without inflating the audit trail. THE RESPONSE IS THE RESULTING STATE, which is what makes channel all worth a single call: three channels move and you see all three. 404 contact_not_found when the id is not this store's.
The channel to suppress. REQUIRED and never defaulted: a client that meant email and dropped the key would otherwise suppress sms and push too, and this API publishes no way to undo that. all fans out to every channel, including push, which the preference page does not render.
email, sms, push, all Response
Success
