Skip to main content
POST
Check if an email is unsubscribed from a company.

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 and company to check

Request body for checking unsubscribe status

companyId
string
required

Company ID

email
string
required

Email to check

Response

Unsubscribe status

Unsubscribe check response

reason
string

Reason for unsubscribe

unsubscribed
boolean

Whether email is unsubscribed