Unsubscribe in one click

POST/v1/alerts/unsubscribe

The List-Unsubscribe URI of every alert email (RFC 8058): the mail client posts List-Unsubscribe=One-Click to it, with no session or other context. The token in the query names the address.

Query parameters

tokenstringRequired

Headers

Idempotency-KeystringRequired: 1 to 255 characters. A retry with the same key returns the first answer.

Responses

200No more email goes to the address
404The link is invalid
503Alerts are not configured

200 response

unsubscribedbooleanRequired: One of true

curl -X POST https://api.keelson.finance/v1/alerts/unsubscribe \
  -H "idempotency-key: $(uuidgen)"

const res = await fetch("https://api.keelson.finance/v1/alerts/unsubscribe", {
  method: "POST",
  headers: {
    "idempotency-key": crypto.randomUUID(),
  },
});
const data = await res.json();

Response · shape from the schema

{
  "unsubscribed": true
}