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-03/statuses/{subscriberIdString}/unsubscribe-all

Request

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

Path parameters

subscriberIdStringstring required

The unique identifier of the subscriber to unsubscribe from all communication preferences.

Query parameters

channel'EMAIL' required

The communication channel from which to unsubscribe the subscriber. This is a required parameter and must be 'EMAIL'.

businessUnitIdinteger

The ID of the business unit to which the subscriber belongs. This is an optional parameter.

verboseboolean

A boolean indicating whether to include detailed information in the response. 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

  • b0d8bc008db9Revision changes
    • info

      the security scope communication_preferences.read was added to the endpoint's security scheme private_apps

    • info

      the security scope communication_preferences.read_write was removed from the endpoint's security scheme private_apps

  • 3578967e48dfRevision changes
    • info

      the security scope communication_preferences.read was added to the endpoint's security scheme private_apps

    • info

      the security scope communication_preferences.read_write was removed from the endpoint's security scheme private_apps

Some revisions have not been checked yet.