Skip to main content
Het legt vast op welke versie het lid zit, welke stap het lid als volgende bereikt en wanneer, en of het lid nog bezig is, klaar is of is geannuleerd. Gebruik de Automation enrollments API om op te vragen wie er in een automation zit, of in welke automations een lid zit. Je kunt ook één enrollment ophalen en er één annuleren om de resterende stappen van dat lid te stoppen.

Endpoints

Attributen

string
vereist
Automation enrollment-ID, met prefix atoe_.
string
vereist
ID van het account waartoe de automation behoort, met prefix biz_.
string
vereist
ID van de automation, met prefix ato_.
string
vereist
Wanneer het lid is ingeschreven, als ISO 8601-tijdstempel.
string | null
vereist
Wanneer de enrollment is beëindigd, als ISO 8601-tijdstempel. null zolang deze actief is.
string
vereist
ID van het lid in de automation, met prefix mber_.
string | null
vereist
Wanneer die stap voor dit lid wordt uitgevoerd, als ISO 8601-tijdstempel. null zodra de enrollment eindigt.
string | null
vereist
ID van die stap in de versie van het lid, met prefix atos_. null zodra de enrollment eindigt.
integer | null
vereist
De key van de stap waarop het lid wacht, in diens versie. null zodra de enrollment eindigt.
string
vereist
active terwijl het lid door de automation gaat. completed na de laatste stap. canceled wanneer het account de enrollment heeft geannuleerd, of de automation heeft gestopt of verwijderd.Beschikbare opties: active, completed, canceled
string | null
vereist
Het webhook-event dat het lid heeft ingeschreven. null wanneer POST /automations/\{id}/trigger het lid heeft ingeschreven.Beschikbare opties: 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
vereist
ID van het record waarover het triggerende event ging, zoals een pay_-betaling of mem_-lidmaatschap. null wanneer een triggerverzoek het lid heeft ingeschreven.
string
vereist
Wanneer de enrollment voor het laatst is gewijzigd, als ISO 8601-tijdstempel.
string | null
vereist
ID van de gebruiker van het lid, met prefix user_. null wanneer het lid een ander bedrijf is.
integer
vereist
De automationversie waarop het lid zit. Deze verandert alleen wanneer een publicatie leden naar de nieuwe versie verplaatst.
AutomationEnrollment