Unsubscribe the token's address (idempotent; RFC 8058 one-click) — emailunsubscribe

POST

/email/unsubscribe/{token}

const url = 'https://example.com/api/email/unsubscribe/example';
const options = {method: 'POST'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/email/unsubscribe/example

Adds the token’s address to email_suppressions (ON CONFLICT DO NOTHING) and renders a done page. Target of the confirm page’s button and of the RFC 8058 one-click POST (List-Unsubscribe=One-Click body, ignored). Malformed or unknown token: 404 page. Rate-limited per IP, per machine (30/min).

Parameters

Path Parameters

token

required

string

Unsubscribe token (UUID) from the email.

Responses

200

Unsubscribed (also on a repeat)

text/html

string

404

Malformed or unknown token

text/html

string

429

Rate limited

500

Write failed (generic page, no detail)

text/html

string