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-03/statuses/batch/unsubscribe-all/read

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Query parameters

channel'EMAIL' required

The communication channel to filter the unsubscribe statuses. This parameter is required and currently supports 'EMAIL' as a valid value.

businessUnitIdinteger

The ID of the business unit to filter the results. This is an optional parameter.

Request body

inputsstring[] required

Strings to input.

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

  • e0403341222cRevision changes
    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added the success response with the status

  • 62586336cea2Revision changes
    • info

      endpoint added

Some revisions have not been checked yet.