Account & Settings
App-Verwaltung
Authentifizierung
Automatisierung
CMS
Communication preferences
Konversationen
Veranstaltungen
Dateien
Marketing
Berichterstattung
Scheduler
curl --request POST \
--url https://api.hubapi.com/communication-preferences/v3/unsubscribe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"emailAddress": "<string>",
"subscriptionId": "<string>",
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "<string>"
}
'{
"description": "<string>",
"id": "<string>",
"name": "<string>",
"sourceOfStatus": "BRAND_WIDE_STATUS",
"status": "NOT_SUBSCRIBED",
"brandId": 123,
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "<string>",
"preferenceGroupName": "<string>"
}Unsubscribe a contact
Unsubscribes a contact from the given subscription type. This API is not valid to use for unsubscribing a contact at a brand or portal level and will return an error.
curl --request POST \
--url https://api.hubapi.com/communication-preferences/v3/unsubscribe \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"emailAddress": "<string>",
"subscriptionId": "<string>",
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "<string>"
}
'{
"description": "<string>",
"id": "<string>",
"name": "<string>",
"sourceOfStatus": "BRAND_WIDE_STATUS",
"status": "NOT_SUBSCRIBED",
"brandId": 123,
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "<string>",
"preferenceGroupName": "<string>"
}Supported products
Supported products
Required Scopes
Required Scopes
Autorisierungen
The access token received from the authorization server in the OAuth 2.0 flow.
Body
Contact's email address.
ID of the subscription being updated for the contact.
Legal basis for updating the contact's status (required for GDPR enabled portals).
CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE A more detailed explanation to go with the legal basis (required for GDPR enabled portals).
Antwort
successful operation
A description of the subscription.
The ID for the subscription.
The name of the subscription.
Where the status is determined from e.g. PORTAL_WIDE_STATUS if the contact opted out from the portal.
BRAND_WIDE_STATUS, PORTAL_WIDE_STATUS, SUBSCRIPTION_STATUS Whether the contact is subscribed.
NOT_SUBSCRIBED, SUBSCRIBED The ID of the brand that the subscription is associated with, if there is one.
The legal reason for the current status of the subscription.
CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE A more detailed explanation to go with the legal basis.
The name of the preferences group that the subscription is associated with.