Batch retrieve contacts who have opted out of all communications
Retrieve the unsubscribe-all status for a batch of subscribers across specified channels. This endpoint is useful for checking the unsubscribe status of multiple subscribers in bulk, particularly for email channels.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Query Parameters
The communication channel to check the unsubscribe status for. This parameter is required and currently only supports 'EMAIL'.
EMAIL The ID of the business unit. This is an optional parameter.
Body
A list of strings representing the inputs for batch operations.
Response
successful operation
The date and time when the batch process was completed.
The array of results from the batch process, each containing subscription status information.
The date and time when the batch process began.
The current status of the batch process, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
CANCELED, COMPLETE, PENDING, PROCESSING A collection of related links associated with the batch response.
The date and time when the batch request was made.