Skip to main content
Unsubscribing a contact sets unsubscribed: true and creates an audit record. Resubscribing removes that record and re-enables email delivery.

Authentication

All endpoints require:
  • Authorization: Bearer YOUR_API_KEY
  • X-Project-ID: YOUR_PROJECT_ID (or encoded in the API key)

Endpoints


Unsubscribe a Contact

Body (all optional)
SDK
Response

Get Unsubscribe Records

SDK

Resubscribe a Contact

Removes all unsubscribe records and sets unsubscribed: false.
SDK
Response

TypeScript Type