Skip to main content
Overview Provide compliant unsubscribe handling and manage category preferences. Unsubscribe
  • Public endpoint: POST /api/unsubscribe (also accepts GET with email/token).
  • Links are added to headers and footer automatically; tokens verify contact identity.
Preferences API
  • GET /api/v1/preferences?token=... → contact, categories, current subscriptions.
  • POST /api/v1/preferences with { token, subscriptions: [{ categoryKey, subscribed }] }.
  • When using API keys: scopes preferences_read / preferences_manage.
When to use
  • Transactional emails: respect user’s global unsubscribed status.
  • Marketing categories: let users opt in/out per topic.
Related
  • API: Preferences
  • API: Unsubscribe