Sign in

v14

latestOpenAPI 3.0.0raw.githubusercontent.com2026-05-279719892.3 MB
Definitions

Retrieve all subscription status definitions

Get a list of subscription status definitions from the account.

get/communication-preferences/2026-03/definitions

Query parameters

businessUnitIdinteger

An integer representing the ID of the business unit for which to retrieve subscription definitions.

includeTranslationsboolean

A boolean indicating whether to include translations of the communication preferences definitions in the response.

Response

successful operation

completedAtstring date-time required

The date and time when the operation was completed.

linksobject

A collection of related links associated with the operation.

numErrorsinteger

The number of errors encountered during the operation.

requestedAtstring date-time

The date and time when the operation was requested.

startedAtstring date-time required

The date and time when the operation started.

status'CANCELED' | 'COMPLETE' | 'PENDING' | 'PROCESSING' required

The current status of the operation, which can be PENDING, PROCESSING, CANCELED, or COMPLETE.