Pular para o conteúdo principal
GET
/
communication-preferences
/
v4
/
statuses
/
{subscriberIdString}
/
unsubscribe-all
Recuperar o status de não assinatura de um contato
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "channel": "EMAIL",
      "status": "NOT_SPECIFIED",
      "subscriberIdString": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "wideStatusType": "BUSINESS_UNIT_WIDE",
      "businessUnitId": 123
    }
  ],
  "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

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 cancelamento de inscrição está sendo recuperado.

Parâmetros de consulta

channel
enum<string>
obrigatório

O canal de comunicação para cancelar a inscrição. Deve ser 'EMAIL'.

Opções disponíveis:
EMAIL
businessUnitId
integer<int64>

O ID da unidade de negócio. Este é um parâmetro inteiro opcional.

verbose
boolean
padrão:false

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

Resposta

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 contendo os resultados da operação.

startedAt
string<date-time>
obrigatório

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

status
enum<string>
obrigatório

O status atual da operação, 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.

Um objeto que contém links relacionados, onde cada chave é um nome de link e cada valor é um URL.

numErrors
integer<int32>

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

requestedAt
string<date-time>

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

Last modified on April 13, 2026