Retrieve a contact's unsubscribed status
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.
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
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the subscriber to unsubscribe from all communication preferences.
Query Parameters
The communication channel from which to unsubscribe the subscriber. This is a required parameter and must be 'EMAIL'.
EMAIL The ID of the business unit to which the subscriber belongs. This is an optional parameter.
A boolean indicating whether to include detailed information in the response. Defaults to false.
Response
successful operation
The date and time when the operation was completed.
An array containing the results of the operation.
The date and time when the operation started.
The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.
CANCELED, COMPLETE, PENDING, PROCESSING An array of error objects detailing any issues encountered during the operation.
An object containing related links, where each key is a link name and each value is a URL.
The number of errors encountered during the operation.
The date and time when the request was made.