Skip to main content
POST
cURL
Stops a sequence that is still running. The sequence transitions to ended with ended_reason: ended-by-user. A sequence cannot be stopped if any of the following are true:
  • its status is ended (already finished),
  • its status is error, or
  • it is actively executing a non-SMS step (status in-progress with a claim in flight on a voice call).
Sequences in queued, paused, or in-progress while waiting on an SMS encounter can be stopped. Attempting to stop a sequence that falls outside these rules returns 400 Bad Request.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

The sequence ID

Response

Stopped sequence result

success
boolean

Indicates if the sequence was successfully stopped