v14

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

Batch

Batch retrieve subscription statuses

Batch retrieve subscription statuses for a set of contacts.

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

channel'EMAIL' required

The communication channel to filter the subscription statuses. Must be 'EMAIL'.

businessUnitIdinteger

An optional integer representing the business unit ID. This parameter helps to filter the results based on the specific business unit.

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.