Skip to main content
POST
Batch read statuses

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

channel
enum<string>
required

A required string indicating the communication channel to filter by. Valid value is 'EMAIL'.

Available options:
EMAIL
businessUnitId
integer<int64>

The ID of the business unit to filter the statuses. It is an integer.

Body

application/json
inputs
string[]
required

A list of strings representing the inputs for batch operations.

Response

successful operation

completedAt
string<date-time>
required

The date and time when the batch process was completed.

results
object[]
required

The array of results from the batch process, each containing subscription status information.

startedAt
string<date-time>
required

The date and time when the batch process began.

status
enum<string>
required

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

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

A collection of related links associated with the batch response.

requestedAt
string<date-time>

The date and time when the batch request was made.

Last modified on March 30, 2026