Skip to main content
It records the version the member is on, the step they reach next and when, and whether they are still going, finished, or canceled. Use the Automation enrollments API to list who is in an automation, or which automations a member is in. You can also retrieve one enrollment, and cancel one to stop that member’s remaining steps.

​
Endpoints

​
Attributes

​
string
required
Automation enrollment ID, prefixed atoe_.
​
string
required
ID of the account the automation belongs to, prefixed biz_.
​
string
required
ID of the automation, prefixed ato_.
​
string
required
When the member enrolled, as an ISO 8601 timestamp.
​
string | null
required
When the enrollment ended, as an ISO 8601 timestamp. null while it’s active.
​
string
required
ID of the member in the automation, prefixed mber_.
​
string | null
required
When that step runs for this member, as an ISO 8601 timestamp. null once the enrollment ends.
​
string | null
required
ID of that step in the member’s version, prefixed atos_. null once the enrollment ends.
​
integer | null
required
The key of the step the member is waiting on, in their version. null once the enrollment ends.
​
string
required
active while the member moves through the automation. completed after its last step. canceled when the account canceled the enrollment, or stopped or deleted the automation.Available options: active, completed, canceled
​
string | null
required
The webhook event that enrolled the member. null when POST /automations/\{id}/trigger enrolled them.Available options: 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
required
ID of the record the triggering event was about, such as a pay_ payment or mem_ membership. null when a trigger request enrolled them.
​
string
required
When the enrollment last changed, as an ISO 8601 timestamp.
​
string | null
required
ID of the member’s user, prefixed user_. null when the member is another business.
​
integer
required
The automation version the member is on. It changes only when a publish moves members to the new version.
AutomationEnrollment