HUhubspot
Status

Get subscription preferences for a specific contact

Changed on

Retrieve a contact's current email subscription preferences.

get/communication-preferences/2026-03/statuses/{subscriberIdString}

Request

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

Path parameters

subscriberIdStringstring required

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

Query parameters

channel'EMAIL' required

The communication channel for which the subscription status is being retrieved. This parameter is required and currently supports only 'EMAIL'.

businessUnitIdinteger

The ID of the business unit to filter the subscription status by. This is an optional parameter.

Response

successful operation

completedAtstring date-time required

The date and time when the operation was completed.

linksobject

Contains URLs related to the response, such as documentation or resources.

numErrorsinteger

The number of errors that occurred 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

Indicates the current status of the operation, with possible values: PENDING, PROCESSING, CANCELED, 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.