Skip to main content
Den registrerer den version, medlemmet er på, det trin, de når næste gang, og hvornår, samt om de stadig er i gang, er færdige eller er annulleret. Brug Automation enrollments API’et til at vise, hvem der er i en automatisering, eller hvilke automatiseringer et medlem er i. Du kan også hente en enkelt tilmelding og annullere en for at stoppe medlemmets resterende trin.

Endpoints

Attributter

string
påkrævet
Automation enrollment-ID med præfikset atoe_.
string
påkrævet
ID for den konto, automatiseringen tilhører, med præfikset biz_.
string
påkrævet
ID for automatiseringen med præfikset ato_.
string
påkrævet
Hvornår medlemmet blev tilmeldt, som et ISO 8601-tidsstempel.
string | null
påkrævet
Hvornår tilmeldingen sluttede, som et ISO 8601-tidsstempel. null, mens den er aktiv.
string
påkrævet
ID for medlemmet i automatiseringen med præfikset mber_.
string | null
påkrævet
Hvornår det trin køres for dette medlem, som et ISO 8601-tidsstempel. null, når tilmeldingen er afsluttet.
string | null
påkrævet
ID for det trin i medlemmets version med præfikset atos_. null, når tilmeldingen er afsluttet.
integer | null
påkrævet
key for det trin, medlemmet venter på, i deres version. null, når tilmeldingen er afsluttet.
string
påkrævet
active, mens medlemmet bevæger sig gennem automatiseringen. completed efter dens sidste trin. canceled, når kontoen annullerede tilmeldingen eller stoppede eller slettede automatiseringen.Tilgængelige muligheder: active, completed, canceled
string | null
påkrævet
Den webhook-hændelse, der tilmeldte medlemmet. null, når POST /automations/\{id}/trigger tilmeldte dem.Tilgængelige muligheder: 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
påkrævet
ID for den post, den udløsende hændelse handlede om, såsom en pay_-betaling eller et mem_-medlemskab. null, når en trigger-anmodning tilmeldte dem.
string
påkrævet
Hvornår tilmeldingen sidst blev ændret, som et ISO 8601-tidsstempel.
string | null
påkrævet
ID for medlemmets bruger med præfikset user_. null, når medlemmet er en anden virksomhed.
integer
påkrævet
Den automatiseringsversion, medlemmet er på. Den ændres kun, når en udgivelse flytter medlemmer til den nye version.
AutomationEnrollment