Passer au contenu principal
GET
/
communication-preferences
/
2026-03
/
definitions
Récupérer toutes les définitions de statut d'abonnement
curl --request GET \
  --url https://api.hubapi.com/communication-preferences/2026-03/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

Autorisations

Authorization
string
header
requis

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

Paramètres de requête

businessUnitId
integer<int64>

L'identifiant unique de l'unité commerciale pour laquelle récupérer les définitions d'abonnement.

includeTranslations
boolean

Un booléen indiquant s'il faut inclure les traductions des définitions d'abonnement. La valeur par défaut est « faux » si non spécifié.

Réponse

successful operation

completedAt
string<date-time>
requis

La date et l'heure de la fin de l'opération.

results
object[]
requis

Un tableau contenant les résultats de l'opération.

startedAt
string<date-time>
requis

La date et l'heure du début de l'opération.

status
enum<string>
requis

Le statut actuel de l'opération, qui peut être EN ATTENTE, EN COURS DE TRAITEMENT, ANNULÉE ou TERMINÉE.

Options disponibles:
CANCELED,
COMPLETE,
PENDING,
PROCESSING
errors
object[]

Une série d'erreurs survenues pendant l'opération.

Une collection de liens associés à l'opération.

numErrors
integer<int32>

Le nombre d'erreurs rencontrées pendant l'opération.

requestedAt
string<date-time>

La date et l'heure auxquelles l'opération a été demandée.

Last modified on April 13, 2026