Skip to main content
Elle enregistre la version sur laquelle se trouve le membre, l’étape qu’il atteindra ensuite et quand, et s’il est toujours en cours, terminé ou annulé. Utilisez l’API Automation enrollments pour lister les personnes inscrites à une automatisation, ou les automatisations auxquelles un membre est inscrit. Vous pouvez aussi récupérer une inscription et en annuler une pour arrêter les étapes restantes de ce membre.

Endpoints

Attributs

string
requis
ID de l’inscription à l’automatisation, préfixé par atoe_.
string
requis
ID du compte auquel appartient l’automatisation, préfixé par biz_.
string
requis
ID de l’automatisation, préfixé par ato_.
string
requis
Date d’inscription du membre, sous forme d’horodatage ISO 8601.
string | null
requis
Date de fin de l’inscription, sous forme d’horodatage ISO 8601. null tant qu’elle est active.
string
requis
ID du membre dans l’automatisation, préfixé par mber_.
string | null
requis
Date à laquelle cette étape s’exécute pour ce membre, sous forme d’horodatage ISO 8601. null une fois l’inscription terminée.
string | null
requis
ID de cette étape dans la version du membre, préfixé par atos_. null une fois l’inscription terminée.
integer | null
requis
La key de l’étape que le membre attend, dans sa version. null une fois l’inscription terminée.
string
requis
active pendant que le membre progresse dans l’automatisation. completed après sa dernière étape. canceled lorsque le compte a annulé l’inscription, ou a arrêté ou supprimé l’automatisation.Options disponibles : active, completed, canceled
string | null
requis
L’événement webhook qui a inscrit le membre. null lorsque c’est POST /automations/\{id}/trigger qui l’a inscrit.Options disponibles : payment.succeeded, payment.failed, membership.activated, membership.trial_ending_soon, member.created, invoice.created, invoice.paid, invoice.past_due, refund.created, dispute.created, resolution_center_case.created, resolution_center_case.decided, course_lesson_interaction.completed
string | null
requis
ID de l’enregistrement concerné par l’événement déclencheur, comme un paiement pay_ ou une adhésion mem_. null lorsqu’une requête de déclenchement l’a inscrit.
string
requis
Date de dernière modification de l’inscription, sous forme d’horodatage ISO 8601.
string | null
requis
ID de l’utilisateur du membre, préfixé par user_. null lorsque le membre est une autre entreprise.
integer
requis
La version de l’automatisation sur laquelle se trouve le membre. Elle ne change que lorsqu’une publication fait passer les membres à la nouvelle version.
AutomationEnrollment