Skip to main content
Registra la versión en la que está el miembro, el siguiente paso al que llegará y cuándo, y si sigue en curso, ha terminado o se ha cancelado. Usa la API de Automation enrollments para listar quién está en una automatización, o en qué automatizaciones está un miembro. También puedes obtener una inscripción y cancelar una para detener los pasos restantes de ese miembro.

Endpoints

Atributos

string
requerido
ID de la inscripción en la automatización, con el prefijo atoe_.
string
requerido
ID de la cuenta a la que pertenece la automatización, con el prefijo biz_.
string
requerido
ID de la automatización, con el prefijo ato_.
string
requerido
Cuándo se inscribió el miembro, como marca de tiempo ISO 8601.
string | null
requerido
Cuándo terminó la inscripción, como marca de tiempo ISO 8601. null mientras está activa.
string
requerido
ID del miembro en la automatización, con el prefijo mber_.
string | null
requerido
Cuándo se ejecuta ese paso para este miembro, como marca de tiempo ISO 8601. null una vez que termina la inscripción.
string | null
requerido
ID de ese paso en la versión del miembro, con el prefijo atos_. null una vez que termina la inscripción.
integer | null
requerido
La key del paso que espera el miembro, en su versión. null una vez que termina la inscripción.
string
requerido
active mientras el miembro avanza por la automatización. completed después de su último paso. canceled cuando la cuenta canceló la inscripción, o detuvo o eliminó la automatización.Opciones disponibles: active, completed, canceled
string | null
requerido
El evento de webhook que inscribió al miembro. null cuando lo inscribió POST /automations/\{id}/trigger.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
string | null
requerido
ID del registro al que se refería el evento desencadenante, como un pago pay_ o una membresía mem_. null cuando lo inscribió una solicitud de activación.
string
requerido
Cuándo cambió la inscripción por última vez, como marca de tiempo ISO 8601.
string | null
requerido
ID del usuario del miembro, con el prefijo user_. null cuando el miembro es otro negocio.
integer
requerido
La versión de la automatización en la que está el miembro. Solo cambia cuando una publicación mueve a los miembros a la nueva versión.
AutomationEnrollment