Take a person out of a sequence

Ends this person’s run through the sequence. Its texts still waiting to go are canceled, and sequence.completed fires with state: "canceled".

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

Send an Idempotency-Key so a retry never acts twice. Idempotency

Path parameters

• idstringrequired

  The run’s id.

  Starts with enr_.

Headers

• Idempotency-Keystring

  Any string of up to 255 characters, new for each request. A retry with the same key gets the first answer back for 24 hours, with Idempotent-Replayed: true.

  Up to 255 characters.

Example

curl -X POST "https://usebluebot.com/api/v1/enrollments/enr_1Hq2LxW9cVbN3mKpRtYs0a/cancel" \
  -H "Authorization: Bearer $BLUEBOT_API_KEY" \
  -H "Idempotency-Key: 0f6d8c2e-5b1a-4c7e-9d3f-2a8b6e1c4d70"

Response

200: The run, ended.

• idstringrequired

  A enr_ id.

  Starts with enr_.

• object"enrollment"required
• sequence_idstringrequired

  A seq_ id.

  Starts with seq_.

• contact_idstringrequired

  A ct_ id.

  Starts with ct_.

• handlestringrequired

  A phone number in E.164 (+15555550123) or an email address an Apple ID uses (iMessage only).

• statestringrequired

  One of active, completed, stopped, canceled.

• current_stepintegerrequired

  The position of the next step.

• next_run_attimestamp or nullrequired

  When the next step happens, while active.

• stop_reasonstring or nullrequired

  Why it ended early, when it did.

  One of replied, stopped, canceled, sequence_archived, failed.

• enrolled_viastringrequired

  One of dashboard, api, zapier, make, n8n, pipedream, cli, hook, keyword, mcp, assistant, widget.

• variablesmap of stringrequired

  Values for the steps’ {{variables}}.

• enrolled_attimestamprequired

  When the person was added.

• completed_attimestamp or nullrequired

  When it ended, by finishing or stopping.

• timelinearray of object

  What happened, oldest first. Only on GET /v1/enrollments/{id}.

  Show its 6 fieldsHide its fields

  • typestringrequired

    One of enrolled, text_queued, text_skipped, waiting, window, stopped, completed, canceled.

  • positioninteger or nullrequired

    The step it is about.

  • message_idstring or nullrequired

    A msg_ id.

    Starts with msg_.

  • untiltimestamp or nullrequired

    For a wait, when it ends.

  • detailstring or nullrequired

    What happened, in words.

  • attimestamprequired

    When.

{
  "id": "enr_1Hq2LxW9cVbN3mKpRtYs0a",
  "object": "enrollment",
  "sequence_id": "seq_1Hq2LxW9cVbN3mKpRtYs0a",
  "contact_id": "ct_1Hq2LxW9cVbN3mKpRtYs0a",
  "handle": "+15555550123",
  "state": "canceled",
  "current_step": 2,
  "next_run_at": null,
  "stop_reason": "canceled",
  "enrolled_via": "api",
  "variables": {
    "listing": "412 Oak St"
  },
  "enrolled_at": "2026-11-13T19:41:00.000Z",
  "completed_at": "2026-11-13T19:41: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