Zum Hauptinhalt springen
POST
/
communication-preferences
/
v4
/
statuses
/
{subscriberIdString}
コンタクトの配信登録ステータスを更新
curl --request POST \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "statusState": "SUBSCRIBED",
  "channel": "EMAIL",
  "legalBasis": "LEGITIMATE_INTEREST_PQL",
  "subscriptionId": 123,
  "legalBasisExplanation": "<string>"
}'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "subscriptionName": "<string>",
      "channel": "EMAIL",
      "subscriberIdString": "<string>",
      "legalBasis": "LEGITIMATE_INTEREST_PQL",
      "setStatusSuccessReason": "RESUBSCRIBE_OCCURRED",
      "source": "<string>",
      "subscriptionId": 123,
      "legalBasisExplanation": "<string>",
      "businessUnitId": 123,
      "status": "SUBSCRIBED",
      "timestamp": "2023-11-07T05:31:56Z"
    }
  ],
  "errors": [
    {
      "subCategory": "",
      "context": "",
      "links": "",
      "id": "",
      "category": "",
      "message": "",
      "errors": "",
      "status": ""
    }
  ],
  "status": "PENDING"
}
次のいずれかの製品またはそれ以上が必要です。
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.

Path Parameters

​
subscriberIdString
string
required

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

Body

application/json
​
statusState
enum<string>
required

次を取り得る、コンタクトの現在の配信登録ステータス：SUBSCRIBED、UNSUBSCRIBED'、またはNOT_SPECIFIED。

Verfügbare Optionen:
SUBSCRIBED,
UNSUBSCRIBED,
NOT_SPECIFIED
​
channel
enum<string>
required

コミュニケーションチャネルのタイプ（現在はEMAILだけがサポートされるオプション）。

Verfügbare Optionen:
EMAIL
​
subscriptionId
integer
required

更新する配信登録の固有ID。

​
legalBasis
enum<string>

コミュニケーションの法的根拠（オプションは、 LEGITIMATE_INTEREST_PQL、LEGITIMATE_INTEREST_CLIENT、PERFORMANCE_OF_CONTRACT、CONSENT_WITH_NOTICE、NON_GDPR、PROCESS_AND_STORE、LEGITIMATE_INTEREST_OTHER）。

Verfügbare Optionen:
LEGITIMATE_INTEREST_PQL,
LEGITIMATE_INTEREST_CLIENT,
PERFORMANCE_OF_CONTRACT,
CONSENT_WITH_NOTICE,
NON_GDPR,
PROCESS_AND_STORE,
LEGITIMATE_INTEREST_OTHER
​
legalBasisExplanation
string

コミュニケーションの法的根拠に関する説明。

Response

successful operation

​
completedAt
string<date-time>
required

処理が完了した日時。

​
startedAt
string<date-time>
required

処理が開始された日時。

​
results
object[]
required

処理から得られる結果の配列。

​
status
enum<string>
required

次の値を取り得る、処理の現在のステータス：PENDING、PROCESSING、CANCELED、COMPLETE.

Verfügbare Optionen:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
​
numErrors
integer

処理中に発生したエラーの数。

​
requestedAt
string<date-time>

リクエストが行われた日時。

​
links
object

ドキュメントやリソースなど、レスポンスに関連するURLが含まれます。

​
errors
object[]

処理中に発生したエラーのリスト。