Skip to content

Render the unsubscribe confirmation page

GET
/v1/unsubscribe/{token}

Public, unauthenticated. Returns a self-contained HTML page with a confirm button (“stop emails from {org}”), a narrower “only this sender” option, and an address-confirm field for multi-recipient (digest) tokens. This endpoint NEVER mutates state (scanner defense); an invalid/expired token yields a graceful static page (still 200, never an enumeration oracle).

token
required
string

Opaque, stateless AEAD unsubscribe token placed in the List-Unsubscribe header of an outbound message. Carries tenant/origin context plus either the single recipient (one-click tokens) or truncated per-recipient digests (multi-recipient tokens); no recipient PII is in the URL.

The unsubscribe page (or a graceful invalid-link page).

string

Throttled (per-IP/token rate limit).