Skip to main content
멤버가 속한 버전, 다음에 도달할 단계와 그 시점, 그리고 진행 중인지, 완료되었는지, 취소되었는지를 기록합니다. Automation enrollments API를 사용하면 자동화에 누가 있는지 또는 멤버가 어떤 자동화에 속해 있는지 나열할 수 있습니다. 등록 하나를 조회하거나, 등록을 취소해 해당 멤버의 남은 단계를 중지할 수도 있습니다.

엔드포인트

속성

string
필수
atoe_ 접두사가 붙은 자동화 등록 ID입니다.
string
필수
자동화가 속한 계정의 ID이며, biz_ 접두사가 붙습니다.
string
필수
ato_ 접두사가 붙은 자동화 ID입니다.
string
필수
멤버가 등록된 시각(ISO 8601 타임스탬프)입니다.
string | null
필수
등록이 종료된 시각(ISO 8601 타임스탬프)입니다. 활성 상태인 동안에는 null입니다.
string
필수
자동화에 있는 멤버의 ID이며, mber_ 접두사가 붙습니다.
string | null
필수
해당 단계가 이 멤버에 대해 실행되는 시각(ISO 8601 타임스탬프)입니다. 등록이 종료되면 null입니다.
string | null
필수
멤버의 버전에서 해당 단계의 ID이며, atos_ 접두사가 붙습니다. 등록이 종료되면 null입니다.
integer | null
필수
멤버의 버전에서 멤버가 대기 중인 단계의 key입니다. 등록이 종료되면 null입니다.
string
필수
멤버가 자동화를 진행하는 동안은 active입니다. 마지막 단계 이후에는 completed입니다. 계정이 등록을 취소했거나 자동화를 중지 또는 삭제한 경우 canceled입니다.사용 가능한 옵션: active, completed, canceled
string | null
필수
멤버를 등록시킨 웹훅 이벤트입니다. POST /automations/\{id}/trigger로 등록된 경우 null입니다.사용 가능한 옵션: 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
필수
pay_ 결제나 mem_ 멤버십처럼 트리거 이벤트의 대상이 된 레코드의 ID입니다. 트리거 요청으로 등록된 경우 null입니다.
string
필수
등록이 마지막으로 변경된 시각(ISO 8601 타임스탬프)입니다.
string | null
필수
멤버의 사용자 ID이며, user_ 접두사가 붙습니다. 멤버가 다른 비즈니스인 경우 null입니다.
integer
필수
멤버가 속한 자동화 버전입니다. 게시를 통해 멤버가 새 버전으로 이동할 때만 변경됩니다.
AutomationEnrollment