Skip to main content
POST
Cancel Automation Enrollment

Autorizaciones

Authorization
string
header
requerido

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.

Scopes

automation:manage

Encabezados

Idempotency-Key
string

A unique key that makes this request safe to retry. See Idempotent requests.

Maximum string length: 255
Ejemplo:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

Automation enrollment ID, prefixed atoe_.

Respuesta

Automation enrollment canceled

account_id
string
requerido

ID of the account the automation belongs to, prefixed biz_.

Ejemplo:

"biz_xxxxxxxxxxxxxx"

automation_id
string
requerido

ID of the automation, prefixed ato_.

Ejemplo:

"ato_xxxxxxxxxxxxxx"

created_at
string
requerido

When the member enrolled, as an ISO 8601 timestamp.

Ejemplo:

"2026-01-01T12:00:00.000Z"

ended_at
string | null
requerido

When the enrollment ended, as an ISO 8601 timestamp. null while it's active.

Ejemplo:

"2026-01-01T12:00:00.000Z"

id
string
requerido

Automation enrollment ID, prefixed atoe_.

Ejemplo:

"atoe_xxxxxxxxxxxxxx"

member_id
string
requerido

ID of the member in the automation, prefixed mber_.

Ejemplo:

"mber_xxxxxxxxxxxxxx"

next_run_at
string | null
requerido

When that step runs for this member, as an ISO 8601 timestamp. null once the enrollment ends.

Ejemplo:

"2026-01-01T12:00:00.000Z"

next_step_id
string | null
requerido

ID of that step in the member's version, prefixed atos_. null once the enrollment ends.

Ejemplo:

"atos_xxxxxxxxxxxxxx"

next_step_key
integer | null
requerido

The key of the step the member is waiting on, in their version. null once the enrollment ends.

Ejemplo:

1

status
enum<string>
requerido

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.

Opciones disponibles:
active,
completed,
canceled
Ejemplo:

"active"

trigger_event
enum<string> | null
requerido

The webhook event that enrolled the member. null when POST /automations/{id}/trigger enrolled them.

Opciones 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,
null
Ejemplo:

"payment.succeeded"

trigger_resource_id
string | null
requerido

ID of the record the triggering event was about, such as a pay_ payment or mem_ membership. null when a trigger request enrolled them.

Ejemplo:

"mber_xxxxxxxxxxxxxx"

updated_at
string
requerido

When the enrollment last changed, as an ISO 8601 timestamp.

Ejemplo:

"2026-01-01T12:00:00.000Z"

user_id
string | null
requerido

ID of the member's user, prefixed user_. null when the member is another business.

Ejemplo:

"user_xxxxxxxxxxxxxx"

version
integer
requerido

The automation version the member is on. It changes only when a publish moves members to the new version.

Ejemplo:

1