コンタクトの配信登録ステータスを更新
curl --request POST \
--url https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"channel": "EMAIL",
"subscriptionId": 123,
"legalBasisExplanation": "<string>"
}
'import requests
url = "https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}"
payload = {
"channel": "EMAIL",
"subscriptionId": 123,
"legalBasisExplanation": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({channel: 'EMAIL', subscriptionId: 123, legalBasisExplanation: '<string>'})
};
fetch('https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'channel' => 'EMAIL',
'subscriptionId' => 123,
'legalBasisExplanation' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}"
payload := strings.NewReader("{\n \"channel\": \"EMAIL\",\n \"subscriptionId\": 123,\n \"legalBasisExplanation\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"EMAIL\",\n \"subscriptionId\": 123,\n \"legalBasisExplanation\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel\": \"EMAIL\",\n \"subscriptionId\": 123,\n \"legalBasisExplanation\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"channel": "EMAIL",
"source": "<string>",
"subscriberIdString": "<string>",
"subscriptionId": 123,
"timestamp": "2023-11-07T05:31:56Z",
"businessUnitId": 123,
"legalBasisExplanation": "<string>",
"subscriptionName": "<string>"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"errors": [
{
"category": "<string>",
"context": {},
"errors": [
{
"message": "<string>",
"code": "<string>",
"context": "{missingScopes=[scope1, scope2]}",
"in": "<string>",
"subCategory": "<string>"
}
],
"links": {},
"message": "<string>",
"status": "<string>",
"id": "<string>",
"subCategory": {}
}
],
"links": {},
"numErrors": 123,
"requestedAt": "2023-11-07T05:31:56Z"
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}ステータス
Update a contact's subscription status
特定のコンタクトの配信登録ステータスを設定します。
POST
/
communication-preferences
/
2026-03
/
statuses
/
{subscriberIdString}
コンタクトの配信登録ステータスを更新
curl --request POST \
--url https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"channel": "EMAIL",
"subscriptionId": 123,
"legalBasisExplanation": "<string>"
}
'import requests
url = "https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}"
payload = {
"channel": "EMAIL",
"subscriptionId": 123,
"legalBasisExplanation": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({channel: 'EMAIL', subscriptionId: 123, legalBasisExplanation: '<string>'})
};
fetch('https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'channel' => 'EMAIL',
'subscriptionId' => 123,
'legalBasisExplanation' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}"
payload := strings.NewReader("{\n \"channel\": \"EMAIL\",\n \"subscriptionId\": 123,\n \"legalBasisExplanation\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"channel\": \"EMAIL\",\n \"subscriptionId\": 123,\n \"legalBasisExplanation\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/communication-preferences/2026-03/statuses/{subscriberIdString}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"channel\": \"EMAIL\",\n \"subscriptionId\": 123,\n \"legalBasisExplanation\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"channel": "EMAIL",
"source": "<string>",
"subscriberIdString": "<string>",
"subscriptionId": 123,
"timestamp": "2023-11-07T05:31:56Z",
"businessUnitId": 123,
"legalBasisExplanation": "<string>",
"subscriptionName": "<string>"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"errors": [
{
"category": "<string>",
"context": {},
"errors": [
{
"message": "<string>",
"code": "<string>",
"context": "{missingScopes=[scope1, scope2]}",
"in": "<string>",
"subCategory": "<string>"
}
],
"links": {},
"message": "<string>",
"status": "<string>",
"id": "<string>",
"subCategory": {}
}
],
"links": {},
"numErrors": 123,
"requestedAt": "2023-11-07T05:31:56Z"
}{
"message": "Invalid input (details will vary based on the error)",
"correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
"category": "VALIDATION_ERROR",
"links": {
"knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
}
}Supported products
Supported products
Required Scopes
Required Scopes
承認
oauth2oauth2
The access token received from the authorization server in the OAuth 2.0 flow.
パスパラメータ
コミュニケーション設定のステータスを更新している登録読者の固有ID。
ボディ
application/json
コミュニケーションチャネルのタイプ(現在はEMAILだけがサポートされるオプション)。
利用可能なオプション:
EMAIL 次を取り得る、コンタクトの現在の配信登録ステータス:SUBSCRIBED、UNSUBSCRIBED'、またはNOT_SPECIFIED。
利用可能なオプション:
NOT_SPECIFIED, SUBSCRIBED, UNSUBSCRIBED 更新する配信登録の固有ID。
コミュニケーションの法的根拠(オプションは、 LEGITIMATE_INTEREST_PQL、LEGITIMATE_INTEREST_CLIENT、PERFORMANCE_OF_CONTRACT、CONSENT_WITH_NOTICE、NON_GDPR、PROCESS_AND_STORE、LEGITIMATE_INTEREST_OTHER)。
利用可能なオプション:
CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE コミュニケーションの法的根拠に関する説明。
レスポンス
successful operation
処理が完了した日時。
処理から得られる結果の配列。
Show child attributes
Show child attributes
処理が開始された日時。
次の値を取り得る、処理の現在のステータス:PENDING、PROCESSING、CANCELED、COMPLETE.
利用可能なオプション:
CANCELED, COMPLETE, PENDING, PROCESSING 処理中に発生したエラーのリスト。
Show child attributes
Show child attributes
ドキュメントやリソースなど、レスポンスに関連するURLが含まれます。
Show child attributes
Show child attributes
処理中に発生したエラーの数。
リクエストが行われた日時。
最終更新日 2026年4月10日
⌘I