Update a contact's subscription status
Set the subscription status of a specific contact.
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 whose communication preferences status is being updated.
Body
The type of communication channel, with 'EMAIL' as the only supported option.
EMAIL The current subscription status of the contact, which can be 'SUBSCRIBED', 'UNSUBSCRIBED', or 'NOT_SPECIFIED'.
NOT_SPECIFIED, SUBSCRIBED, UNSUBSCRIBED The unique identifier of the subscription to be updated.
The legal basis for communication, with options including 'LEGITIMATE_INTEREST_PQL', 'LEGITIMATE_INTEREST_CLIENT', 'PERFORMANCE_OF_CONTRACT', 'CONSENT_WITH_NOTICE', 'NON_GDPR', 'PROCESS_AND_STORE', and 'LEGITIMATE_INTEREST_OTHER'.
CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE An explanation for the legal basis used for communication.
Response
successful operation
The date and time when the operation was completed.
An array of results from the operation.
The date and time when the operation started.
Indicates the current status of the operation, with possible values: PENDING, PROCESSING, CANCELED, COMPLETE.
CANCELED, COMPLETE, PENDING, PROCESSING A list of errors that occurred during the operation.
Contains URLs related to the response, such as documentation or resources.
The number of errors that occurred during the operation.
The date and time when the request was made.