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

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 consulta

businessUnitId
integer<int64>

Um número inteiro que representa o ID da unidade de negócio para filtrar as definições de assinatura.

includeTranslations
boolean

Um booleano que indica se as traduções das definições de assinatura devem ser incluídas na resposta.

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 April 13, 2026