Skip to main content
POST
Add multiple company-specific unsubscribes from a CSV import.

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

Emails to unsubscribe in bulk

Request body for bulk adding unsubscribes

companyId
string
required

Company ID

emails
string[]
required

List of emails to unsubscribe

reason
string

Reason for unsubscribe

Response

Bulk unsubscribe results

Bulk unsubscribes response

added
integer

Number of new unsubscribes added

failed
integer

Number of emails that failed

results
object[]

Per-email results

skipped
integer

Number of emails already unsubscribed