Skip to main content
GET
One-click email unsubscribe

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Headers

X-Test-Mode
enum<string>

Sandbox 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.

Available options:
true,
false

Path Parameters

token
string
required

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.