Client API: Email preferences

Base URL: https://api.coritan.com/api/v1. Paths below are complete.

To try these requests in the browser, open the interactive Client API reference.

GET /api/v1/email/unsubscribe

What an email's unsubscribe link will turn off. Changes nothing.

Answers a page with an Unsubscribe button that posts back to this address, or, when the request asks for JSON, {"category", "label", "subscribed", "email"}: the kind of email the token names, how the email settings label it, whether the account still gets it, and the address, masked. 400 when the token is not one we signed, 404 when its account is gone.

POST /api/v1/email/unsubscribe

Turn off the kind of email the token names, for its account only.

The one-click unsubscribe of RFC 8058: a mail app posts List-Unsubscribe=One-Click to the address in the email's List-Unsubscribe header, and the token in its query string is all this route reads. Security and billing email cannot be turned off, and no token names them. Answers {"ok": true, "category", "label", "changed"}, where changed is false when the kind was already off, or a page when the request asks for HTML. 400 when the token is not one we signed, 404 when its account is gone.