cURL
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>",
"legalBasisExplanation": "<string>"
}
'import requests
url = "https://api.hubapi.com/communication-preferences/v3/unsubscribe"
payload = {
"emailAddress": "<string>",
"subscriptionId": "<string>",
"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({
emailAddress: '<string>',
subscriptionId: '<string>',
legalBasisExplanation: '<string>'
})
};
fetch('https://api.hubapi.com/communication-preferences/v3/unsubscribe', 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/v3/unsubscribe",
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([
'emailAddress' => '<string>',
'subscriptionId' => '<string>',
'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/v3/unsubscribe"
payload := strings.NewReader("{\n \"emailAddress\": \"<string>\",\n \"subscriptionId\": \"<string>\",\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/v3/unsubscribe")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"emailAddress\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"legalBasisExplanation\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/communication-preferences/v3/unsubscribe")
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 \"emailAddress\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"legalBasisExplanation\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"description": "<string>",
"id": "<string>",
"name": "<string>",
"brandId": 123,
"legalBasisExplanation": "<string>",
"preferenceGroupName": "<string>"
}{
"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"
}
}v3
Unsubscribe a contact
POST
/
communication-preferences
/
v3
/
unsubscribe
cURL
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>",
"legalBasisExplanation": "<string>"
}
'import requests
url = "https://api.hubapi.com/communication-preferences/v3/unsubscribe"
payload = {
"emailAddress": "<string>",
"subscriptionId": "<string>",
"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({
emailAddress: '<string>',
subscriptionId: '<string>',
legalBasisExplanation: '<string>'
})
};
fetch('https://api.hubapi.com/communication-preferences/v3/unsubscribe', 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/v3/unsubscribe",
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([
'emailAddress' => '<string>',
'subscriptionId' => '<string>',
'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/v3/unsubscribe"
payload := strings.NewReader("{\n \"emailAddress\": \"<string>\",\n \"subscriptionId\": \"<string>\",\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/v3/unsubscribe")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"emailAddress\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"legalBasisExplanation\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.hubapi.com/communication-preferences/v3/unsubscribe")
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 \"emailAddress\": \"<string>\",\n \"subscriptionId\": \"<string>\",\n \"legalBasisExplanation\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"description": "<string>",
"id": "<string>",
"name": "<string>",
"brandId": 123,
"legalBasisExplanation": "<string>",
"preferenceGroupName": "<string>"
}{
"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.
ボディ
application/json
レスポンス
successful operation
利用可能なオプション:
BRAND_WIDE_STATUS, PORTAL_WIDE_STATUS, SUBSCRIPTION_STATUS 利用可能なオプション:
NOT_SUBSCRIBED, SUBSCRIBED 利用可能なオプション:
CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE 最終更新日 2026年4月10日
⌘I