Passer au contenu principal
POST
/
communication-preferences
/
2026-03
/
statuses
/
{subscriberIdString}
Mettre à jour le statut d'abonnement d'un contact
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

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

subscriberIdString
string
requis

L'identifiant unique de l'abonné*e dont le statut d'abonnement doit être mis à jour.

Corps

application/json
channel
enum<string>
requis

Le type de canal de communication, avec « E-MAIL » comme seule option prise en charge.

Options disponibles:
EMAIL
statusState
enum<string>
requis

Le statut d'abonnement actuel du contact, qui peut être « SUBSCRIBED », « UNSUBSCRIBED » ou « NOT_SPECIFIED ».

Options disponibles:
NOT_SPECIFIED,
SUBSCRIBED,
UNSUBSCRIBED
subscriptionId
integer<int64>
requis

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 ».

Options disponibles:
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.

Réponse

successful operation

completedAt
string<date-time>
requis

La date et l'heure de la fin de l'opération.

results
object[]
requis

Une série de résultats issus de l'opération.

startedAt
string<date-time>
requis

La date et l'heure du début de l'opération.

status
enum<string>
requis

Indique l'état actuel de l'opération, avec les valeurs possibles suivantes : EN ATTENTE, EN COURS DE TRAITEMENT, ANNULÉ, TERMINÉ.

Options disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Liste des erreurs survenues pendant l'opération.

Contient les URL liées à la réponse, telles que la documentation ou les ressources.

numErrors
integer<int32>

Le nombre d'erreurs survenues pendant l'opération.

requestedAt
string<date-time>

La date et l'heure auxquelles la demande a été faite.

Last modified on April 13, 2026