HUhubspot
Definitions

Unsubscribe a contact from all subscriptions

Changed on

Unsubscribe a contact from all email subscriptions.

post/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 to unsubscribe from. Must be 'EMAIL'.

businessUnitIdinteger

The ID of the business unit associated with the request. This is an optional integer 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

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_write was added to the endpoint's security scheme private_apps

    • info

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

  • 3578967e48dfRevision changes
    • info

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

    • info

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

Some revisions have not been checked yet.