Zum Hauptinhalt springen
POST
/
communication-preferences
/
v3
/
unsubscribe
コンタクトを配信停止
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"
}
次のいずれかの製品またはそれ以上が必要です。
Marketing HubMarketing Hub -無料ツール
Sales HubSales Hub -無料ツール
Service HubService Hub -無料ツール
Content HubContent Hub -無料ツール
この API には、次のいずれかのスコープが必要です。
communication_preferences.read_write
communication_preferences.write

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
emailAddress
string
required

コンタクトのEメールアドレス。

​
subscriptionId
string
required

コンタクトについて更新される配信登録のID。

​
legalBasis
enum<string>

コンタクトのステータスを更新する法的根拠（GDPR対応のポータルに必要）。

Available options:
LEGITIMATE_INTEREST_PQL,
LEGITIMATE_INTEREST_CLIENT,
PERFORMANCE_OF_CONTRACT,
CONSENT_WITH_NOTICE,
NON_GDPR,
PROCESS_AND_STORE,
LEGITIMATE_INTEREST_OTHER
​
legalBasisExplanation
string

法的根拠に付随するより詳細な説明（GDPR対応のポータルに必要）。

Response

successful operation

​
name
string
required

配信登録の名前。

​
description
string
required

配信登録の説明。

​
id
string
required

配信登録のID。

​
status
enum<string>
required

コンタクトが配信登録されているかどうか。

Available options:
SUBSCRIBED,
NOT_SUBSCRIBED
​
sourceOfStatus
enum<string>
required

コンタクトがポータルからオプトアウトした場合にステータスが判断される根拠（例えば、PORTAL_WIDE_STATUS）。

Available options:
PORTAL_WIDE_STATUS,
BRAND_WIDE_STATUS,
SUBSCRIPTION_STATUS
​
brandId
integer

配信登録が関連付けられているブランドのID（ある場合）。

​
legalBasis
enum<string>

配信登録の現在のステータスの法的理由。

Available options:
LEGITIMATE_INTEREST_PQL,
LEGITIMATE_INTEREST_CLIENT,
PERFORMANCE_OF_CONTRACT,
CONSENT_WITH_NOTICE,
NON_GDPR,
PROCESS_AND_STORE,
LEGITIMATE_INTEREST_OTHER
​
preferenceGroupName
string

配信登録が関連付けられている設定グループの名前。

​
legalBasisExplanation
string

法的根拠に付随するより詳細な説明。

⌘I