One-click email unsubscribe
Public List-Unsubscribe endpoint. Verifies the HMAC-signed token embedded in every outbound email’s List-Unsubscribe URL, records the recipient address on the tenant suppression list (idempotent), then either 302-redirects to the organization’s configured unsubscribe page or renders a minimal HTML confirmation. POST is the RFC 8058 one-click method (mailbox gateways POST without a body); GET is the human-click fallback. Invalid, expired, or tampered tokens return an HTTP 400 HTML error page.
Authorizations
Dashboard JWT token from Clerk
Headers
Stripe-style idempotency token. Pass a stable, client-generated value (1-255 chars) to dedupe retries on transient timeouts. The same key+credential+path replays the original response for 24h on 2xx (5min on 4xx, 30s on 5xx). Returns 409 if a concurrent request with the same key is already in flight; replayed responses include the Idempotency-Replay: true response header.
1 - 255Sandbox opt-in for Clerk-session-authenticated requests. Set to true to route the call through the test-mode pipeline: no real provider delivery, no credits deducted, response meta.test_mode: true. Ignored for live API keys (dv_live_sk_*) — server-to-server clients must use a test-prefixed key (dv_test_sk_*) to exercise sandbox. Test-prefixed keys unconditionally enable sandbox regardless of this header.
true, false Path Parameters
HMAC-signed token binding tenant, message id, and recipient address; minted into the message's List-Unsubscribe URL at send time.
Response
Minimal HTML confirmation page when the organization has no custom unsubscribe redirect configured.
Minimal HTML confirmation page when the organization has no custom unsubscribe redirect configured.