Change a sequence

Renames it, pauses or resumes it, archives it (which ends every active run), or replaces its steps. People already in it carry on from the step number they reached.

Needs a key with the messages:send scope. Keys and scopes

Path parameters

• idstringrequired

  The sequence’s id.

  Starts with seq_.

Request body

• namestring

  Up to 120 characters.

• descriptionstring or null

  Up to 500 characters.

• statestring

  Pause, resume or archive it. Archiving ends every active enrollment.

  One of active, paused, archived.

• stop_on_replyboolean
• send_windowobject or null

  When steps may send, in your time zone. A step due outside it waits for it to open.

  Show its 3 fieldsHide its fields

  • daysarray of stringsrequired

    The days it may send on.

    One of mon, tue, wed, thu, fri, sat, sun.

  • startstringrequired

    A time of day as HH:MM in your account’s time zone.

  • endstringrequired

    A time of day as HH:MM in your account’s time zone.

• stepsarray of any

  Replaces every step. People already in it carry on from the step number they reached.

  Up to 50 items.

Example

curl -X PATCH "https://usebluebot.com/api/v1/sequences/seq_1Hq2LxW9cVbN3mKpRtYs0a" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "state": "paused"
  }'

Response

200: The changed sequence.

• idstringrequired

  A seq_ id.

  Starts with seq_.

• object"sequence"required
• namestringrequired
• descriptionstring or nullrequired
• statestringrequired

  active takes new people and sends; paused holds every enrollment where it is; archived ends them.

  One of active, paused, archived.

• stop_on_replybooleanrequired

  Stop a person’s run when they text back. On unless you turn it off. A stop word always stops it.

• send_windowobject or nullrequired

  When steps may send, in your time zone. A step due outside it waits for it to open.

  Show its 3 fieldsHide its fields

  • daysarray of stringsrequired

    The days it may send on.

    One of mon, tue, wed, thu, fri, sat, sun.

  • startstringrequired

    A time of day as HH:MM in your account’s time zone.

  • endstringrequired

    A time of day as HH:MM in your account’s time zone.

• stepsarray of SequenceSteprequired
  Show its 7 fieldsHide its fields

  • idstringrequired

    A step_ id.

    Starts with step_.

  • positionintegerrequired

    Its place in the sequence, from 0.

  • kindstringrequired

    One of text, wait.

  • wait_secondsinteger or nullrequired

    For a wait: how long, from a minute to a year.

  • textstring or nullrequired

    For a text: the words, with {{variables}}.

  • template_idstring or nullrequired

    For a text: the template it uses instead of text.

  • servicestringrequired

    One of auto, imessage, sms.

• countsmap of integerrequired

  Enrollments by state: active, completed, stopped, canceled.

• created_viastringrequired

  One of dashboard, api, assistant, mcp, zapier, cli.

• created_attimestamprequired

  When it was made.

{
  "id": "seq_1Hq2LxW9cVbN3mKpRtYs0a",
  "object": "sequence",
  "name": "New lead follow-up",
  "description": "For people who ask about a listing.",
  "state": "paused",
  "stop_on_reply": true,
  "send_window": {
    "days": [
      "mon",
      "tue",
      "wed",
      "thu",
      "fri"
    ],
    "start": "09:00",
    "end": "18:00"
  },
  "steps": [
    {
      "id": "step_1Hq2LxW9cVbN3mKpRtYs0a",
      "position": 0,
      "kind": "text",
      "wait_seconds": null,
      "text": "Hi {{first_name|there}}, thanks for asking about {{listing}}. Want to see it?",
      "template_id": null,
      "service": "auto"
    },
    {
      "id": "step_2Bf8QzD4kJmA6nXwEuTr1c",
      "position": 1,
      "kind": "wait",
      "wait_seconds": 172800,
      "text": null,
      "template_id": null,
      "service": "auto"
    },
    {
      "id": "step_3Lp3VsC7hGqE5tZyKbWn2d",
      "position": 2,
      "kind": "text",
      "wait_seconds": null,
      "text": "Just checking in. Still interested in {{listing}}?",
      "template_id": null,
      "service": "auto"
    }
  ],
  "counts": {
    "active": 12,
    "completed": 30,
    "stopped": 9,
    "canceled": 1
  },
  "created_via": "dashboard",
  "created_at": "2026-11-01T15:00:00.000Z"
}

Errors

Every refusal has the same envelope and a page of its own. These are the ones this operation can give.

Try it