Pular para o conteúdo principal
GET
/
communication-preferences
/
v4
/
definitions
Recuperar todas as definições de status de assinatura
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/definitions \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "results": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "description": "<string>",
      "id": "<string>",
      "isActive": true,
      "isDefault": true,
      "isInternal": true,
      "name": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z",
      "businessUnitId": 123,
      "communicationMethod": "<string>",
      "purpose": "<string>",
      "subscriptionTranslations": [
        {
          "createdAt": 123,
          "description": "<string>",
          "languageCode": "<string>",
          "name": "<string>",
          "subscriptionId": 123,
          "updatedAt": 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"
}

Produtos suportados

Requer um dos seguintes produtos ou superior.
Marketing HubMarketing Hub -Starter
Sales HubSales Hub -Grátis
Service HubService Hub -Grátis
Content HubContent Hub -Grátis

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

businessUnitId
integer<int64>

Se você tiver o complemento de unidade de negócio, inclua este parâmetro para filtrar os resultados por ID de unidade de negócio. A unidade de negócio padrão da conta sempre usará "0".

includeTranslations
boolean

Defina como "true" para retornar traduções de assinatura associadas a cada definição.

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 erros que ocorreram durante a operação.

Uma coleção de links relacionados associados à operação.

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 operação foi solicitada.

Last modified on December 8, 2025