ReferencePublic
/api/v1/unsubscribe
No session needed. Takes the link's u, k and s. Answers 410 like get-unsubscribe.
POST
/api/v1/unsubscribeRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
curl -X POST "https://example.com/api/v1/unsubscribe" \ -H "Content-Type: application/json" \ -d '{ "k": "string", "s": "string", "scope": "kind", "subscribed": true, "u": "string" }'{ "email": "string", "group": "household", "groupKinds": { "property1": true, "property2": true }, "groupSubscribed": true, "kind": "comment", "kindSubscribed": true, "username": "string"}/api/v1/unsubscribe GET
No session needed; changes nothing. A forged or expired link, or one naming an account or kind that is gone, answers 410.
/api/v1/unsubscribe/one-click POST
The address of a mail's List-Unsubscribe header. No session needed. The body, List-Unsubscribe=One-Click as urlencoded or multipart form data, is not read: the signed address alone decides. Switches off the mail of the link's kind only and answers 200 with no body, or 410 like get-unsubscribe.