Recovery Sequences

Create a sequence

curl -X POST https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/sequences \
  -H "Authorization: Bearer sbt_..." \
  -H "Idempotency-Key: 6b1f0d2e-9c3a-4e8b-b2d1-7a9c5e3f1d04" \
  -H "Content-Type: application/json" \
  -d '{"name": "Win-back after churn", "steps": [{"delay_days": 3, "body": "Hi {name}, your place in {project} is still here: {link}"}, {"delay_days": 7, "body": "{coupon} takes {discount} off: {link}", "coupon_id": "3b7c9d1e-5f24-4a86-9c0b-2d4e6f8a1b3c"}]}'

Builds the sequence with its steps in one write and answers it with 201; trigger defaults to churned and active to true. Up to 8 steps, the first 0 to 180 days after the trigger (0 goes out on the next hourly run) and each later one 1 to 180 days after the one before, with a message of 1 to 1,000 characters. A sequence built without steps exists and enrols nobody until it has one.

The body is sent as a chat message, so a step with a coupon reads best when it uses {coupon} and {discount}, and every step should end on {link}, which is the way back.

post/v1/projects/{project}/sequences

Request

  • Base URL: https://api.subscriby.net
  • URL: https://api.subscriby.net/v1/projects/{project}/sequences
  • Auth: HTTP bearer

Path parameters

projectstring uuid required

The project, resolved by the route binder.

Headers

Idempotency-Keystring uuid required

A key unique to this operation, such as a fresh UUID. The same key replays the original 2xx response for 24 hours (with Idempotent-Replay: true), so a retry after a timeout never repeats the write; the same key with a different body is refused with 409.

Request body

namestring required

A creator-facing label, 1 to 120 characters; such as Win-back after churn.

trigger'churned' | 'lead' | 'stalled_checkout' | 'trial_ending'

What enrols a member: churned (their last live membership ended; the default), lead (they arrived without buying), stalled_checkout (a checkout they started stayed open past the project's window) or trial_ending (a trial without a card is about to end).

activeboolean

Whether the sequence enrols and sends from the start. Defaults to true.

Response

The new sequence, 201.

Example response

{
  "data": {
    "id": "9d2f4b6a-1c3e-4f58-8a7b-6e5d4c3b2a19",
    "project_id": "7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13",
    "name": "Win-back after churn",
    "trigger": "churned",
    "active": true,
    "steps": [
      {
        "id": "4e8a2c6d-7b1f-4d93-a5c0-8f2e1b7d6c54",
        "position": 1,
        "delay_days": 3,
        "body": "Hi {name}, your place in {project} is still here whenever you want it back: {link}"
      }
    ],
    "created_at": "2026-10-01T09:00:00+00:00",
    "updated_at": "2026-10-10T08:00:00+00:00"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.