Update a contact's subscription status

defina o status de assinatura de um contato específico.

POST /communication-preferences/2026-03/statuses/{subscriberIdString}

Atualizar o status de assinatura de um contato

cURL

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>"
}
'

200

{
  "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

Autorizações

Authorization · string · header · obrigatório

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

Parâmetros de caminho

subscriberIdString · string · obrigatório

O identificador exclusivo do assinante cujo status de assinatura deve ser atualizado.

Corpo

application/json

channel · enum<string> · obrigatório

O tipo de canal de comunicação, com "EMAIL" como a única opção suportada.

Opções disponíveis: EMAIL

statusState · enum<string> · obrigatório

O status atual da assinatura do contato, que pode ser "SUBSCRIBED", "UNSUBSCRIBED" ou "NOT_SPECIFIED".

Opções disponíveis: NOT_SPECIFIED, SUBSCRIBED, UNSUBSCRIBED

subscriptionId · integer<int64> · obrigatório

O identificador exclusivo da assinatura a ser atualizada.

legalBasis · enum<string>

A base jurídica para comunicação, com opções incluindo "LEGITIMATE_INTEREST_PQL", "LEGITIMATE_INTEREST_CLIENT", "PERFORMANCE_OF_CONTRACT", "CONSENT_WITH_NOTICE", "NON_GDPR", "PROCESS_AND_STORE" e "LEGITIMATE_INTEREST_OTHER".

Opções disponíveis: CONSENT_WITH_NOTICE, LEGITIMATE_INTEREST_CLIENT, LEGITIMATE_INTEREST_OTHER, LEGITIMATE_INTEREST_PQL, NON_GDPR, PERFORMANCE_OF_CONTRACT, PROCESS_AND_STORE

legalBasisExplanation · string

Uma explicação para a base jurídica usada para comunicação.

Resposta

200

application/json

successful operation

completedAt · string<date-time> · obrigatório

A data e a hora em que a operação foi concluída.

results · object[] · obrigatório

Uma série de resultados da operação.

Show child attributes

startedAt · string<date-time> · obrigatório

A data e a hora em que a operação começou.

status · enum<string> · obrigatório

Indica o status atual da operação, com valores possíveis: PENDING, PROCESSING, CANCELED, COMPLETE.

Opções disponíveis: CANCELED, COMPLETE, PENDING, PROCESSING

errors · object[]

Uma lista de erros que ocorreram durante a operação.

Show child attributes

links · object

Contém URLs relacionados à resposta, como documentação ou recursos.

Show child attributes

numErrors · integer<int32>

O número de erros que ocorreram durante a operação.

requestedAt · string<date-time>

A data e a hora em que a solicitação foi feita.