Unsubscribe a set of contacts from all email subscriptions.
Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
The channel type for the subscription type. Currently, the only supported channel type is EMAIL.
EMAIL If you have the business unit add-on, include this parameter to filter results by business unit ID. The default Account business unit will always use 0.
Set to true to include the details of the updated subscription statuses in the response. Not including this parameter will result in an empty response.
A list of strings representing the inputs for batch operations.
successful operation
The date and time when the bulk opt-out operation was completed.
An array containing the results of the bulk opt-out from all communications operation.
The date and time when the bulk opt-out operation began.
The current status of the bulk opt-out operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
CANCELED, COMPLETE, PENDING, PROCESSING An array of error objects detailing any issues encountered during the bulk opt-out operation.
A collection of URLs linking to related resources or documentation.
The total number of errors encountered during the bulk opt-out operation.
The date and time when the bulk opt-out request was made.