---
title: "Batch retrieve contacts who have opted out of all communications"
method: POST
path: "/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read"
tags: ["Batch"]
---

# Batch retrieve contacts who 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: one of:
  - HTTP bearer
  - API key in query parameter `hapikey`
  - none

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

## Query parameters

- `channel` 'EMAIL', required
- `businessUnitId` integer

## Request body

- BatchInputString
  - `inputs` string[], required: Strings to input.

## Response `200`

successful operation

- CommunicationPreferencesBatchResponsePublicWideStatusBulkResponse
  - `completedAt` string, date-time, required: The date and time when the batch process was completed.
  - `links` object: A collection of related links associated with the batch response.
  - `requestedAt` string, date-time: The date and time when the batch request was made.
  - `results` CommunicationPreferencesPublicWideStatusBulkResponse[], required: The array of results from the batch process, each containing subscription status information.
    - `subscriberIdString` string, required: The contact's email address.
    - `wideStatuses` CommunicationPreferencesPublicWideStatus[], required: An array containing the wide status results for the operation.
      - `businessUnitId` integer: The ID of the business unit associated with the status.
      - `channel` 'EMAIL', required: The type of communication channel, with 'EMAIL' as the only supported option.
      - `status` 'NOT_SPECIFIED' | 'SUBSCRIBED' | 'UNSUBSCRIBED', required: The subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
      - `subscriberIdString` string, required: The email address of the contact.
      - `timestamp` string, date-time, required: The date and time when the status was recorded.
      - `wideStatusType` 'BUSINESS_UNIT_WIDE' | 'PORTAL_WIDE', required: The type of wide status, which can be 'PORTAL_WIDE' or 'BUSINESS_UNIT_WIDE'.
  - `startedAt` string, 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.

## Other responses

- `207`: multiple statuses
- `default`: An error occurred.

## Changes

> 14 revisions in range; 1 not diffed, 2 could not be searched.

- **2026-04-01** `e0403341222c`: 2 warning, 1 info
  - removed the optional property `errors` from the response with the `200` status
  - removed the optional property `numErrors` from the response with the `200` status
  - added the success response with the status `207`
- **2026-03-25** `62586336cea2`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/hubspot/apis/hubspot-api-specification/changes/communication-preferences/2026-03/statuses/batch/unsubscribe-all/read/post.md)

---

[API](https://skmtc.dev/hubspot/apis/hubspot-api-specification.md) - [All operations](https://skmtc.dev/hubspot/apis/hubspot-api-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/hubspot/apis/hubspot-api-specification/revisions/f9c7181056c5?raw)