v1
latestOpenAPI 3.0.32026-07-267015229.9 KBObjectives
Create Objectives
This endpoint creates objectives for a PAL.
post/v2/objectives
Request body
Example request
{
"data": [
{
"objective_name": "ask_if_new_patient",
"objective_prompt": "Ask the patient if they are new or have been here before",
"confirmation_mode": "auto",
"output_variables": [
"patient_status"
],
"modality": "verbal",
"next_conditional_objectives": {
"new_patient_intake_process": "If the patient has never been to the practice before",
"existing_patient_intake_process": "If the patient has been to the practice before"
},
"next_required_objective": "get_patient_name",
"callback_url": "https://your-server.com/webhook"
}
]
}Response
Objective created successfully
Example response
{
"objectives_id": "o12345",
"objective_name": "New Objectives",
"status": "active",
"created_at": "2024-01-15T10:30:00Z"
}