Skip to main content
POST
/
sequence-manager
/
sequence-definitions
cURL
curl --request POST \
  --url https://api.clarionhealth.com/v1/sequence-manager/sequence-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "description": "<string>",
  "steps": [
    {
      "order": 123,
      "type": "voice",
      "config": {}
    }
  ]
}'
{
  "id": 123,
  "name": "<string>",
  "status": "active",
  "steps_definition": [
    {
      "id": "<string>",
      "type": "voice",
      "order": 123,
      "delay_hours": 123,
      "voice_assistant_id": 123,
      "messaging_assistant_id": 123,
      "inputs": [
        {
          "id": "<string>",
          "name": "<string>",
          "type": "text",
          "required": true
        }
      ]
    }
  ],
  "inputs_definition": [
    {
      "id": "<string>",
      "name": "<string>",
      "type": "text",
      "required": true
    }
  ],
  "outreach_schedule": {
    "timezone": "America/New_York",
    "business_hours": {
      "start": "09:00",
      "end": "17:00"
    },
    "days_of_week": [
      "monday"
    ]
  },
  "voice_assistant_id": 123,
  "organization_id": 123,
  "ehr_action": "has-ehr-file",
  "created_at": "2023-11-07T05:31:56Z",
  "is_archived": true,
  "allow_repeat_contact": true
}

Authorizations

Authorization
string
header
required

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

Body

application/json

The sequence definition object

name
string
required

Name of the sequence definition

steps
object[]
required

List of steps in the sequence definition

description
string

Description of the sequence definition

Response

Created sequence definition with ID

id
integer

Unique identifier for the sequence definition

name
string

Name of the sequence definition

status
enum<string>

Status of the sequence definition

Available options:
active,
inactive,
archived
steps_definition
object[]

Definition of steps in the sequence

inputs_definition
object[]

Definition of inputs required for the sequence

outreach_schedule
object

Schedule configuration for outreach

voice_assistant_id
integer | null

ID of the voice assistant to use

organization_id
integer

ID of the organization this definition belongs to

ehr_action
enum<string>

EHR action associated with this sequence

Available options:
has-ehr-file,
no-ehr-file,
any
created_at
string<date-time>

When the sequence definition was created

is_archived
boolean

Whether the sequence definition is archived

allow_repeat_contact
boolean

Whether to allow repeat contact attempts