Cancel Automation Enrollment
Cancels an active enrollment: the member gets none of the automation’s remaining steps, and their enrollment becomes canceled. The member can enroll in the automation again later.
Authorizations
An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.
Headers
A unique key that makes this request safe to retry. See Idempotent requests.
255"d9105228-4a08-46b1-8b91-42fed586d383"
Pins the request to a dated API version.
"2026-11-05-1"
Path Parameters
Automation enrollment ID, prefixed atoe_.
Response
Automation enrollment canceled
ID of the account the automation belongs to, prefixed biz_.
"biz_xxxxxxxxxxxxxx"
ID of the automation, prefixed ato_.
"ato_xxxxxxxxxxxxxx"
When the member enrolled, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
When the enrollment ended, as an ISO 8601 timestamp. null while it's active.
"2026-01-01T12:00:00.000Z"
Automation enrollment ID, prefixed atoe_.
"atoe_xxxxxxxxxxxxxx"
ID of the member in the automation, prefixed mber_.
"mber_xxxxxxxxxxxxxx"
When that step runs for this member, as an ISO 8601 timestamp. null once the enrollment ends.
"2026-01-01T12:00:00.000Z"
ID of that step in the member's version, prefixed atos_. null once the enrollment ends.
"atos_xxxxxxxxxxxxxx"
The key of the step the member is waiting on, in their version. null once the enrollment ends.
1
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.
active, completed, canceled "active"
The webhook event that enrolled the member. null when POST /automations/{id}/trigger enrolled them.
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, null "payment.succeeded"
ID of the record the triggering event was about, such as a pay_ payment or mem_ membership. null when a trigger request enrolled them.
"mber_xxxxxxxxxxxxxx"
When the enrollment last changed, as an ISO 8601 timestamp.
"2026-01-01T12:00:00.000Z"
ID of the member's user, prefixed user_. null when the member is another business.
"user_xxxxxxxxxxxxxx"
The automation version the member is on. It changes only when a publish moves members to the new version.
1

