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>"
}コンタクトが特定の配信カテゴリーから配信停止されます。このAPIはブランドまたはポータルレベルでのコンタクトの配信停止への使用には適しておらず、エラーが返されます。
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>"
}Documentation Index
Fetch the complete documentation index at: https://developers.hubspot.jp/docs/llms.txt
Use this file to discover all available pages before exploring further.
Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
コンタクトのEメールアドレス。
コンタクトについて更新される配信登録のID。
コンタクトのステータスを更新する法的根拠(GDPR対応のポータルに必要)。
CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE 法的根拠に付随するより詳細な説明(GDPR対応のポータルに必要)。
successful operation
配信登録の説明。
配信登録のID。
配信登録の名前。
コンタクトがポータルからオプトアウトした場合にステータスが判断される根拠(例えば、PORTAL_WIDE_STATUS)。
BRAND_WIDE_STATUS, PORTAL_WIDE_STATUS, SUBSCRIPTION_STATUS コンタクトが配信登録されているかどうか。
NOT_SUBSCRIBED, SUBSCRIBED 配信登録が関連付けられているブランドのID(ある場合)。
配信登録の現在のステータスの法的理由。
CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE 法的根拠に付随するより詳細な説明。
配信登録が関連付けられている設定グループの名前。