Zum Hauptinhalt springen
GET
/
communication-preferences
/
v3
/
status
/
email
/
{emailAddress}
コンタクトの配信登録ステータスを取得
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v3/status/email/{emailAddress} \
  --header 'Authorization: Bearer <token>'
{
  "recipient": "<string>",
  "subscriptionStatuses": [
    {
      "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
communication_preferences.read_write

Authorizations

Authorization
string
header
required

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

Path Parameters

emailAddress
string
required

The email address of the contact whose subscription statuses are being retrieved.

Response

successful operation

recipient
string
required

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

subscriptionStatuses
object[]
required

コンタクトの全配信登録のステータスのリスト。

I