Recovery Sequences

Change a sequence

curl -X PATCH https://api.subscriby.net/v1/projects/7f3d1c92-8b45-4e6a-9d21-5c8e0a4b6f13/sequences/9d2f4b6a-1c3e-4f58-8a7b-6e5d4c3b2a19 \
  -H "Authorization: Bearer sbt_..." \
  -H "Idempotency-Key: 0c4e8a2d-6f1b-4c9e-8d3a-5b7f9e1c2d64" \
  -H "Content-Type: application/json" \
  -d '{"active": false}'

Any subset of the name, the trigger and the switch; fields left out keep their stored values. Switching a sequence off lets every member part-way through go, as sequence.exited with the reason disabled, and enrols nobody until it runs again; switching it back on enrols nobody retroactively.

steps, when present, replaces the whole list in order: a step still at its place keeps its id and a member due it keeps their position, the rest are appended and the extra ones removed from the end. Send [] to remove every step. One sequence.updated announces the sequence as it then stands.

patch/v1/projects/{project}/sequences/{sequence}

Request

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

Path parameters

projectstring uuid required

The project, resolved by the route binder.

sequencestring uuid required

The sequence, resolved within the project 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

A new creator-facing label, 1 to 120 characters.

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

What enrols a member: churned, lead, stalled_checkout or trial_ending. Members already part-way through keep their passage.

activeboolean

Switch the sequence on or off. Off lets every member part-way through go, as sequence.exited with the reason disabled, and enrols nobody until it runs again.

Response

The sequence as it now reads.

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.