Skip to main content
GET
/
communication-preferences
/
v4
/
definitions
Recuperar todas las definiciones de estado de suscripción
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/v4/definitions \
  --header 'Authorization: Bearer <token>'
{
  "completedAt": "2023-11-07T05:31:56Z",
  "numErrors": 123,
  "requestedAt": "2023-11-07T05:31:56Z",
  "startedAt": "2023-11-07T05:31:56Z",
  "links": {},
  "results": [
    {
      "isInternal": true,
      "createdAt": "2023-11-07T05:31:56Z",
      "isDefault": true,
      "communicationMethod": "<string>",
      "purpose": "<string>",
      "name": "<string>",
      "description": "<string>",
      "id": "<string>",
      "isActive": true,
      "businessUnitId": 123,
      "subscriptionTranslations": [
        {
          "createdAt": 123,
          "name": "<string>",
          "description": "<string>",
          "subscriptionId": 123,
          "languageCode": "<string>",
          "updatedAt": 123
        }
      ],
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "errors": [
    {
      "subCategory": "",
      "context": "",
      "links": "",
      "id": "",
      "category": "",
      "message": "",
      "errors": "",
      "status": ""
    }
  ],
  "status": "PENDING"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito
Esta API requiere uno de los siguientes ámbitos:
communication_preferences.read
communication_preferences.read_write

Authorizations

Authorization
string
header
required

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

Query Parameters

businessUnitId
integer

Si tienes el complemento unidad de negocio, incluye este parámetro para filtrar los resultados por el ID de la unidad de negocio. La unidad de negocio predeterminada de la cuenta siempre utilizará 0.

includeTranslations
boolean

Establecer en «true» para devolver las traducciones de suscripción asociadas a cada definición.

Response

successful operation

completedAt
string<date-time>
required

La fecha y la hora en que se completó la operación.

startedAt
string<date-time>
required

La fecha y la hora en que se inició la operación.

results
object[]
required

Una matriz que contiene los resultados de la operación.

status
enum<string>
required

El estado actual de la operación, puede ser PENDIENTE, PROCESANDO, CANCELADO o COMPLETADO.

Available options:
PENDING,
PROCESSING,
CANCELED,
COMPLETE
numErrors
integer

El número de errores encontrados durante la operación.

requestedAt
string<date-time>

La fecha y la hora en que se solicitó la operación.

Una colección de enlaces asociados con la operación.

errors
object[]

Una matriz de los errores que se produjeron durante la operación.