Skip to main content
POST
Add a company-specific unsubscribe.

Authorizations

X-API-Key
string
header
required

Company API key - scoped to a specific company. Generate from the Integrations page in your dashboard.

Body

application/json

Email to unsubscribe

Request body for adding an unsubscribe

companyId
string
required

Company ID

email
string
required

Email to unsubscribe

reason
string

Reason for unsubscribe

Response

Created unsubscribe record

Created unsubscribe response

companyId
string

Company ID

created
string

Creation date

email
string

Email address

id
string

Unsubscribe ID