Batch unsubscribe contacts from all subscriptions

Cancele a assinatura de um conjunto de contatos de todas as assinaturas de e-mail.

POST /communication-preferences/2026-03/statuses/batch/unsubscribe-all

Cancelar em lote a assinatura dos contatos de todos os tipos de assinatura

cURL

curl --request POST \
  --url https://api.hubapi.com/communication-preferences/2026-03/statuses/batch/unsubscribe-all \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "inputs": [
    "<string>"
  ]
}
'

200

{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "subscriberIdString": "<string>",
      "statuses": [
        {
          "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 consulta

channel · enum<string> · obrigatório

Uma string obrigatória que especifica o canal de comunicação. Atualmente, apenas 'EMAIL' é compatível.

Opções disponíveis: EMAIL

businessUnitId · integer<int64>

O ID da unidade de negócio à qual a operação se aplica. É um parâmetro opcional.

verbose · boolean · padrão: false

Um booleano que indica se informações detalhadas devem ser incluídas na resposta. O padrão é falso.

Corpo

application/json

inputs · string[] · obrigatório

Uma lista de strings que representam as entradas para operações em lote.

Resposta

200

application/json

successful operation

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

A data e a hora em que a operação de opt-out em massa foi concluída.

results · object[] · obrigatório

Uma série contendo os resultados de opt-out em massa de todas as operações de comunicação.

Show child attributes

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

A data e a hora em que a operação de opt-out em massa começou.

status · enum<string> · obrigatório

O status atual da operação de opt-out em massa, que pode ser PENDING, PROCESSING, CANCELED ou COMPLETE.

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

errors · object[]

Uma série de objetos de erro detalhando quaisquer problemas encontrados durante a operação de opt-out em massa.

Show child attributes

links · object

Uma coleção de URLs com links para recursos ou documentação relacionados.

Show child attributes

numErrors · integer<int32>

O número total de erros encontrados durante a operação de opt-out em massa.

requestedAt · string<date-time>

A data e a hora em que a solicitação de opt-out em massa foi feita.