Skip to main content
POST
Confirm a one-click email unsubscribe

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Path Parameters

token
string
required

Signed, single-use unsubscribe token minted by Orbit and embedded in the email's List-Unsubscribe header. Opaque to callers.

Body

application/x-www-form-urlencoded
List-Unsubscribe
enum<string>

RFC 8058 one-click marker. Mail clients send exactly List-Unsubscribe=One-Click.

Available options:
One-Click

Response

The recipient was suppressed and no sender redirect is configured; a minimal HTML confirmation page is returned.

The response is of type string.