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",
"statusState": "NOT_SPECIFIED",
"subscriptionId": 123,
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "<string>"
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"channel": "EMAIL",
"source": "<string>",
"status": "NOT_SPECIFIED",
"subscriberIdString": "<string>",
"subscriptionId": 123,
"timestamp": "2023-11-07T05:31:56Z",
"businessUnitId": 123,
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "<string>",
"setStatusSuccessReason": "NO_STATUS_CHANGE",
"subscriptionName": "<string>"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"status": "CANCELED",
"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"
}Définir le statut d’abonnement d’un contact spécifique.
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",
"statusState": "NOT_SPECIFIED",
"subscriptionId": 123,
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "<string>"
}
'{
"completedAt": "2023-11-07T05:31:56Z",
"results": [
{
"channel": "EMAIL",
"source": "<string>",
"status": "NOT_SPECIFIED",
"subscriberIdString": "<string>",
"subscriptionId": 123,
"timestamp": "2023-11-07T05:31:56Z",
"businessUnitId": 123,
"legalBasis": "CONSENT_WITH_NOTICE",
"legalBasisExplanation": "<string>",
"setStatusSuccessReason": "NO_STATUS_CHANGE",
"subscriptionName": "<string>"
}
],
"startedAt": "2023-11-07T05:31:56Z",
"status": "CANCELED",
"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"
}Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
L'identifiant unique de l'abonné*e dont le statut d'abonnement doit être mis à jour.
Le type de canal de communication, avec « E-MAIL » comme seule option prise en charge.
EMAIL Le statut d'abonnement actuel du contact, qui peut être « SUBSCRIBED », « UNSUBSCRIBED » ou « NOT_SPECIFIED ».
NOT_SPECIFIED, SUBSCRIBED, UNSUBSCRIBED L'identifiant unique de l'abonnement à mettre à jour.
La base juridique de la communication, avec les options suivantes : « LEGITIMATE_INTEREST_PQL », « LEGITIMATE_INTEREST_CLIENT », « PERFORMANCE_OF_CONTRACT », « CONSENT_WITH_NOTICE », « NON_GDPR », « PROCESS_AND_STORE » et « LEGITIMATE_INTEREST_OTHER ».
CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE Une explication de la base juridique utilisée pour la communication.
successful operation
La date et l'heure de la fin de l'opération.
Une série de résultats issus de l'opération.
Show child attributes
La date et l'heure du début de l'opération.
Indique l'état actuel de l'opération, avec les valeurs possibles suivantes : EN ATTENTE, EN COURS DE TRAITEMENT, ANNULÉ, TERMINÉ.
CANCELED, COMPLETE, PENDING, PROCESSING Liste des erreurs survenues pendant l'opération.
Show child attributes
Contient les URL liées à la réponse, telles que la documentation ou les ressources.
Show child attributes
Le nombre d'erreurs survenues pendant l'opération.
La date et l'heure auxquelles la demande a été faite.