Skip to main content
POST
/
sequence-manager
/
sequences
cURL
curl --request POST \
  --url https://api.clarionhealth.com/v1/sequence-manager/sequences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "steps": [
    {
      "order": 123,
      "type": "voice",
      "config": {}
    }
  ]
}'
{
  "success": true,
  "data": {
    "id": 123,
    "status": "in-progress",
    "ended_reason": "<string>",
    "ended_reason_v2": "<string>",
    "current_step": 123,
    "next_activity": "2023-11-07T05:31:56Z",
    "organization_id": 123,
    "patient_id": 123,
    "type": "appointment_reminder",
    "steps": [
      {
        "id": "<string>",
        "type": "voice",
        "inputs": [
          {}
        ],
        "status": "pending",
        "scheduled_at": "2023-11-07T05:31:56Z",
        "voicemail_message": "<string>",
        "source_number": "<string>",
        "destination_number": "<string>",
        "voice_assistant_id": 123,
        "post_actions": [
          {}
        ]
      }
    ],
    "sequence_definition_id": 123,
    "inputs": [
      {
        "id": "<string>",
        "value": "<string>",
        "name": "<string>",
        "type": "text"
      }
    ],
    "outcome": "<string>",
    "was_contact_reached": true,
    "claimed_at": "2023-11-07T05:31:56Z",
    "is_test_mode": true,
    "last_updated": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json

The sequence object

name
string
required

Name of the sequence

steps
object[]
required

List of steps in the sequence

description
string

Description of the sequence

Response

Created sequence with ID

success
boolean

Indicates if the request was successful

data
object

The created sequence object