Create or update a subscription

Autorisations

Authorization

string

header

requis

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

Corps

application/json

Option 1
Option 2
Option 3
Option 4
Option 5

actions

enum<string>[]

requis

Un tableau de chaînes de caractères spécifiant les actions qui déclenchent l'abonnement. Les actions valides incluent « CREATE », « UPDATE », « DELETE », « MERGE », « RESTORE ».

Options disponibles:

CREATE,

UPDATE,

DELETE,

MERGE,

RESTORE,

ASSOCIATION_ADDED,

ASSOCIATION_REMOVED,

SNAPSHOT,

APP_INSTALL,

APP_UNINSTALL,

ADDED_TO_LIST,

REMOVED_FROM_LIST,

GDPR_DELETE

objectIds

integer<int64>[]

requis

Un tableau d'entiers représentant les ID des objets impliqués dans l'abonnement. Un tableau vide signifie s'abonner à tous les objectIds.

objectTypeId

string

requis

Une chaîne de caractères qui identifie le type d'objet pour lequel l'abonnement est créé ou mis à jour. Par exemple, « 0-1 » pour les contacts.

portalId

integer<int64>

requis

Un entier représentant l'ID du portail associé à l'abonnement.

properties

string[]

requis

Un tableau de chaînes de caractères listant les propriétés des objets pertinentes pour l'abonnement. Un tableau vide signifie que toutes les propriétés sont écoutées.

subscriptionType

enum<string>

défaut:OBJECT

requis

Une chaîne indiquant le type d'abonnement. La valeur par défaut et la seule valeur valide est « OBJECT ».

Options disponibles:

OBJECT

Réponse

successful operation

actions

enum<string>[]

requis

Une liste d'actions qui déclenchent l'abonnement. Les valeurs possibles incluent « CREATE », « UPDATE », « DELETE », « MERGE », « RESTORE », « ASSOCIATION_ADDED », « ASSOCIATION_REMOVED », « SNAPSHOT », « APP_INSTALL », « APP_UNINSTALL », « ADDED_TO_LIST », « REMOVED_FROM_LIST » et « RGPD_DELETE ».

Options disponibles:

CREATE,

UPDATE,

DELETE,

MERGE,

RESTORE,

ASSOCIATION_ADDED,

ASSOCIATION_REMOVED,

SNAPSHOT,

APP_INSTALL,

APP_UNINSTALL,

ADDED_TO_LIST,

REMOVED_FROM_LIST,

GDPR_DELETE

appId

integer<int64>

requis

L'identifiant unique de l'application associée à l'abonnement. Il s'agit d'un entier formaté en int64.

createdAt

string<date-time>

requis

La date et l'heure de création de l'abonnement, au format ISO 8601.

integer<int64>

requis

L'identifiant unique de l'abonnement. Il s'agit d'un entier formaté en int64.

objectTypeId

string

requis

L'identifiant du type d'objet associé à l'abonnement. Il s'agit d'une chaîne de caractères.

subscriptionType

enum<string>

requis

Le type d'abonnement, qui peut être l'un des suivants : « OBJECT », « ASSOCIATION », « EVENT », « APP_LIFECYCLE_EVENT », « LIST_MEMBERSHIP » ou « RGPD_PRIVACY_DELETION ».

Options disponibles:

APP_LIFECYCLE_EVENT,

ASSOCIATION,

EVENT,

GDPR_PRIVACY_DELETION,

LIST_MEMBERSHIP,

OBJECT

updatedAt

string<date-time>

requis

La date et l'heure de la dernière mise à jour de l'abonnement, au format ISO 8601.

actionOverrides

object

Un objet contenant des remplacements d'action, où chaque clé est une action et la valeur est un objet ActionOverrideRequest.

Show child attributes

associatedObjectTypeIds

string[]

Une liste d'ID de types d'objets associés. Chaque ID est une chaîne de caractères.

createdBy

integer<int64>

L'ID de l'utilisateur qui a créé l'abonnement. Il s'agit d'un entier formaté en int64.

deletedAt

string<date-time>

La date et l'heure de suppression de l'abonnement, au format ISO 8601, le cas échéant.

listIds

integer<int64>[]

Une liste d'ID de listes associées à l'abonnement. Chaque ID est un entier au format int64.

objectIds

integer<int64>[]

Une liste d'ID d'objets associés à l'abonnement. Chaque ID est un entier formaté en int64.

portalId

integer<int64>

L'identifiant unique du portail associé à l'abonnement. Il s'agit d'un entier formaté en int64.

properties

string[]

Une liste de noms de propriétés associés à l'abonnement. Chaque propriété est une chaîne de caractères.