v14

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

Batch

Batch retrieve contacts who have opted out of all communications

Checks whether a set of contacts have opted out of all communications.

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

channel'EMAIL' required

The communication channel to filter the unsubscribe statuses. This parameter is required and currently supports 'EMAIL' as a valid value.

businessUnitIdinteger

The ID of the business unit to filter the results. This is an optional parameter.

inputsstring[] required

Strings to input.

successful operation

completedAtstring date-time required

The date and time when the batch process was completed.

linksobject

A collection of related links associated with the batch response.

requestedAtstring date-time

The date and time when the batch request was made.

startedAtstring date-time required

The date and time when the batch process began.

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

The current status of the batch process, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.