v5

latestOpenAPI 3.0.12026-07-13142666.0 KB
Batch

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

Query parameters

channel'EMAIL' required
businessUnitIdinteger

Request body

inputsstring[] required

A list of strings representing the inputs for batch operations.

Response

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.

numErrorsinteger
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.