Win-back Sequences API
A win-back sequence is the ordered set of messages a member who leaves receives on the days the creator chose: each step waits a number of days after the one before (the first after the trigger), says what the creator wrote with {name}, {project}, {coupon}, {discount} and {link} filled per member, carries the way back as a button and, optionally, a coupon.
A win-back sequence is the ordered set of messages a member who leaves receives on the days the creator chose: each step waits a number of days after the one before (the first after the trigger), says what the creator wrote with {name}, {project}, {coupon}, {discount} and {link} filled per member, carries the way back as a button and, optionally, a coupon. A member enrols once per departure, never while they hold a live membership, and leaves the sequence the moment a charge settles for them, which counts as a win. Sequences live under a project at /v1/projects/{project}/sequences.
Sequences need Growth or the Revenue Recovery Addon. Building or changing one on a plan without them is refused as 422 VALIDATION_FAILED; a sequence that exists when the plan lapses keeps its rows and holds every due step until the plan includes sequences again.
The only trigger available today is churned: the member's last live membership ended. lead, stalled_checkout and trial_ending are declared for the lead-nurture release and refused until it ships.
Endpoints
/v1/projects/{project}/sequencesList a project's sequencesPOST/v1/projects/{project}/sequencesCreate a sequenceGET/v1/projects/{project}/sequences/{sequence}Get a sequencePATCH/v1/projects/{project}/sequences/{sequence}Change a sequenceDELETE/v1/projects/{project}/sequences/{sequence}Delete a sequenceGET/v1/projects/{project}/sequences/{sequence}/enrollmentsList a sequence's enrolmentsRelated
How is this guide?
Last updated on