POST
/
communication-preferences
/
v3
/
unsubscribe
Unsubscribe a contact
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v3/unsubscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "emailAddress": "<string>",
  "legalBasis": "LEGITIMATE_INTEREST_PQL",
  "subscriptionId": "<string>",
  "legalBasisExplanation": "<string>"
}'
{
  "brandId": 123,
  "name": "<string>",
  "description": "<string>",
  "legalBasis": "LEGITIMATE_INTEREST_PQL",
  "preferenceGroupName": "<string>",
  "id": "<string>",
  "legalBasisExplanation": "<string>",
  "status": "SUBSCRIBED",
  "sourceOfStatus": "PORTAL_WIDE_STATUS"
}
Supported products
Requires one of the following products or higher.
Marketing HubMarketing HubFree
Sales HubSales HubFree
Service HubService HubFree
Content HubContent HubFree

​
Required Scopes

This API requires one of the following scopes:
  • communication_preferences.write
  • communication_preferences.read_write

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

Response

200
application/json

successful operation

The response is of type object.