v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB

Batch

Batch unsubscribe contacts from all subscriptions

Unsubscribe a set of contacts from all email subscriptions.

post/communication-preferences/2026-03/statuses/batch/unsubscribe-all

channel'EMAIL' required

The communication channel from which subscribers will be unsubscribed. This parameter is required and currently supports only 'EMAIL'.

businessUnitIdinteger

An optional integer representing the business unit ID for which the operation is being performed.

verboseboolean

A boolean indicating whether to include detailed information in the response. Defaults to false.

inputsstring[] required

Strings to input.

successful operation

completedAtstring date-time required

The date and time when the bulk opt-out operation was completed.

linksobject

A collection of URLs linking to related resources or documentation.

numErrorsinteger

The total number of errors encountered during the bulk opt-out operation.

requestedAtstring date-time

The date and time when the bulk opt-out request was made.

startedAtstring date-time required

The date and time when the bulk opt-out operation began.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The current status of the bulk opt-out operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.