Batch unsubscribe contacts from all subscriptions
Unsubscribe a set of contacts from all email subscriptions.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
- Authorization URL
- https://app.hubspot.com/oauth/authorize
- Token URL
- https://api.hubapi.com/oauth/v1/token
Query Parameters
The communication channel from which to unsubscribe all subscribers. This parameter is required and currently supports only 'EMAIL'.
EMAIL The ID of the business unit for which the operation is being performed. This is an optional parameter.
A boolean flag indicating whether to include detailed information in the response. Defaults to false.
Body
A list of strings representing the inputs for batch operations.
Response
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.