Organization API: Org Email Preferences

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

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

GET /api/v1/orgs/{org_slug}/email/unsubscribe

What the link in a news email will do. Changes nothing.

Answers a page in the organization's name with a Stop news and offers button that posts back to this address. 400, with a page that says nothing about the customer, when the token is not the one we signed for this customer and organization. 429 when the network asks too often.

POST /api/v1/orgs/{org_slug}/email/unsubscribe

Stop news and offers for the customer the token names.

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 query string is all this route reads, so a form body of any shape is accepted. Emails a customer needs to run their account are not affected. Answers 200 {"ok": true}, or a page when the request asks for HTML, and the same 200 when the customer had already stopped them. 400 when the token is not the one we signed for this customer and organization; the answer never says whether the customer exists. 429 when the network asks too often.