Billing

Unsubscribe an address from offers and announcements

Public and session-less by necessity: the link lives in an email, and an unsubscribe that asks the reader to log in first is one they abandon — they mark the next message as spam instead, which costs the sending domain far more. The t parameter is an HMAC over the address, which is what stops a stranger unsubscribing somebody else.

Offers and announcements only. Transactional mail — sign-in codes, approval requests, invitations, reports the recipient asked for — does not consult this flag and is unaffected; turning it off must never lock someone out of their account.

Idempotent, and the answer is the same whether or not the address has an account. "Stop emailing me" is always answered "done", and a 404 here would tell a caller holding a valid token which addresses are registered.

get/v1/marketing/unsubscribe

Request

  • Base URL: https://api.1claw.co
  • URL: https://api.1claw.co/v1/marketing/unsubscribe
  • Auth: none required

Query parameters

emailstring email required
tstring required

HMAC over the address, from the link.

cstring

Campaign the link came from. Recorded, not trusted.

Response

Unsubscribed (or already was)

unsubscribedboolean required
emailstring required
messagestring required

Changes

No recorded changes to this operation across all 1 revision of this API.