Skip to main content
POST
/
communication-preferences
/
2026-03
/
statuses
/
batch
/
read
Batch retrieve subscription statuses
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/read \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "statuses": [
        {
          "channel": "EMAIL",
          "source": "<string>",
          "status": "NOT_SPECIFIED",
          "subscriberIdString": "<string>",
          "subscriptionId": 123,
          "timestamp": "2023-11-07T05:31:56Z",
          "businessUnitId": 123,
          "legalBasis": "CONSENT_WITH_NOTICE",
          "legalBasisExplanation": "<string>",
          "setStatusSuccessReason": "NO_STATUS_CHANGE",
          "subscriptionName": "<string>"
        }
      ],
      "subscriberIdString": "<string>"
    }
  ],
  "startedAt": "2023-11-07T05:31:56Z",
  "status": "CANCELED",
  "links": {},
  "requestedAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://developers.hubspot.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

channel
enum<string>
required

The communication channel to filter the subscription statuses. Must be 'EMAIL'.

Available options:
EMAIL
businessUnitId
integer<int64>

An optional integer representing the business unit ID. This parameter helps to filter the results based on the specific business unit.

Body

application/json
inputs
string[]
required

A list of strings representing the inputs for batch operations.

Response

successful operation

completedAt
string<date-time>
required

The date and time when the batch process was completed.

results
object[]
required

The array of results from the batch process, each containing subscription status information.

startedAt
string<date-time>
required

The date and time when the batch process began.

status
enum<string>
required

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

Available options:
CANCELED,
COMPLETE,
PENDING,
PROCESSING

A collection of related links associated with the batch response.

requestedAt
string<date-time>

The date and time when the batch request was made.

Last modified on May 11, 2026