HUhubspot
Batch

Batch retrieve contacts who have opted out of all communications

Changed on

Checks whether a set of contacts have opted out of all communications.

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

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/communication-preferences/2026-09/statuses/batch/unsubscribe-all/read
  • 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.read

Query parameters

channel'EMAIL' required

A required string specifying the communication channel. Currently, only 'EMAIL' is supported.

businessUnitIdinteger

An optional integer representing the business unit ID to filter the results.

Request body

inputsstring[] required

A list of strings representing the inputs for batch operations.

Response

successful operation

completedAtstring date-time required

The date and time when the batch process was completed.

linksobject

A collection of related links associated with the batch response.

requestedAtstring date-time

The date and time when the batch request was made.

startedAtstring date-time required

The date and time when the batch process began.

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

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

Changes

  • 2026-09e1706f57adc0Revision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      added the success response with the status