Skip to content

Area: Developers

POST

One-click unsubscribe (RFC 8058)

Path
/unsubscribe/oneclick/{payload}
Auth
None · a public or signed link
POST
/unsubscribe/oneclick/{payload}
curl --request POST \
--url https://releva.ai/api/v0/unsubscribe/oneclick/example \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data List-Unsubscribe=One-Click

Called by mail clients from the List-Unsubscribe and List-Unsubscribe-Post headers that Releva adds to every email. The body must be List-Unsubscribe=One-Click. Same effect as POST /unsubscribe.

payload
required
string

URL-encoded base64 JSON minted by Releva (encrypted secret, email or phone number, redirect URL). Never build it yourself.

object
List-Unsubscribe
required
string
Allowed value: One-Click

Example

List-Unsubscribe=One-Click

Unsubscribed. Empty body.

Body missing or not One-Click, or invalid payload.

Media typetext/html
string

Example

Bad Request

The unsubscribe could not be saved.

Media typetext/html
string

Example

Internal Server Error