Documentation / Consent & unsubscribe
BUILD

Consent & unsubscribe

Make preferences explicit and keep an auditable record of marketing choices.

Record opt-in evidence

Supply marketing_consent:true only after an explicit marketing choice, together with consent_source describing the actual capture point. Server-generated consented_at and recorded consent events retain the accepted evidence. The API does not independently verify your user’s choice. For an optional checkbox and backend example, follow Collect consent in your app at /docs/checkbox-consent.

Honor revocation

Setting marketing_consent:false records revocation and adds a marketing suppression. Campaign audience selection requires consent and excludes suppressed addresses. Workers recheck delivery eligibility rather than treating a stale audience snapshot as permission.

Built-in unsubscribe

Marketing email includes an unsubscribe link and RFC 8058 one-click headers. The signed link opens a confirmation page; POST /unsubscribe applies the preference. Tokens are tenant-specific. Your integration should not generate or store its own replacements for these links.

Suppression scope

Bounces, complaints, explicit suppressions, and unsubscribe preferences protect recipients. Use the dashboard or contacts:read to inspect suppressions. There is no public API that silently removes suppressions. Investigate the underlying preference or delivery problem.

Building something interesting?We’d love to help