Batch

Batch unsubscribe contacts from all subscriptions

Unsubscribe a set of contacts from all email subscriptions.

post/communication-preferences/2026-09/statuses/batch/unsubscribe-all

Request

Base URL
https://api.hubapi.com
URL
https://api.hubapi.com/communication-preferences/2026-09/statuses/batch/unsubscribe-all
Auth
OAuth 2
Authorization code: https://app.hubspot.com/oauth/authorize
Token URL: https://api.hubapi.com/oauth/v1/token scopes: communication_preferences.statuses.batch.write

channel'EMAIL' required

The communication channel from which to unsubscribe all subscribers. This parameter is required and currently supports only 'EMAIL'.

businessUnitIdinteger

The ID of the business unit for which the operation is being performed. This is an optional parameter.

verboseboolean

A boolean flag indicating whether to include detailed information in the response. Defaults to false.

inputsstring[] required

A list of strings representing the inputs for batch operations.

successful operation

completedAtstring date-time required

The date and time when the bulk opt-out operation was completed.

linksobject

A collection of URLs linking to related resources or documentation.

numErrorsinteger

The total number of errors encountered during the bulk opt-out operation.

requestedAtstring date-time

The date and time when the bulk opt-out request was made.

startedAtstring date-time required

The date and time when the bulk opt-out operation began.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The current status of the bulk opt-out operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.

Sep 3, 20262026-09e1706f57adc0 Revision changes
- breaking
  the //// response's property format changed from int32 to int64 for status
- info
  the endpoint scheme security private_apps was removed from the API