Skip to main content
POST
/
sequence-manager
/
sequences
/
{id}
/
stop
cURL
curl --request POST \
  --url https://api.clarionhealth.com/v1/sequence-manager/sequences/{id}/stop \
  --header 'Authorization: Bearer <token>'
{
  "success": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.clarionhealth.com/llms.txt

Use this file to discover all available pages before exploring further.

Only sequences that have a status of in-progress, queued, or paused may be stopped. Attempting to stop a sequence with a different status will result in a 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