HUhubspot
Status

Retrieve a contact's unsubscribed status

Changed on

Check whether a contact has unsubscribed from all email subscriptions. If a contact has not opted out of all communications, the response results array will be empty.

get/communication-preferences/2026-09/statuses/{subscriberIdString}/unsubscribe-all

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/communication-preferences/2026-09/statuses/{subscriberIdString}/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.read_write

Path parameters

subscriberIdStringstring required

The unique identifier of the subscriber whose unsubscribe status is being retrieved.

Query parameters

channel'EMAIL' required

The communication channel for which the unsubscribe status is being checked. Must be 'EMAIL'.

businessUnitIdinteger

An optional integer representing the business unit ID.

verboseboolean

A boolean indicating whether to include detailed information. Defaults to false.

Response

successful operation

completedAtstring date-time required

The date and time when the operation was completed.

linksobject

An object containing related links, where each key is a link name and each value is a URL.

numErrorsinteger

The number of errors encountered during the operation.

requestedAtstring date-time

The date and time when the request was made.

startedAtstring date-time required

The date and time when the operation started.

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

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

Changes

  • 2026-09e1706f57adc0Revision changes
    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the endpoint scheme security private_apps was removed from the API

    • info

      the security scope communication_preferences.read_write was added to the endpoint's security scheme oauth2

    • info

      the security scope communication_preferences.read was removed from the endpoint's security scheme oauth2

    • info

      api tag Status added

    • info

      api tag Basic removed