How do I use Curogram’s AI Calls to Action API to automate workflows from an AI assistant?
AI Calls to Action – API Integration Guide
Overview
The AI Calls to Action API allows your AI system (e.g., AI receptionist, chatbot, or voice assistant) to trigger predefined actions inside Curogram.
Each action is uniquely identified by an actionId, and all actions are executed via a single API endpoint per practice.
How It Works (High-Level)
- You configure actions inside the Curogram dashboard
- For each action, you can configure any or all of the functions below:
- Automate sending a message template
- Auto-assign task to user/s
- Automate adding/removing the patient from a patient group
- Auto-assign conversation topic
- Each action is assigned a unique actionId (UUID)
- Your AI system sends a POST request to the API
- The API executes the corresponding action based on the actionId
API Endpoint
Each practice has a unique API endpoint:
POST https://api-v2.curogram.com/api-v2/actions/<practice-token>
⚠️ Replace https://api-v2.curogram.com/api-v2/actions/<practice-token> with the endpoint provided by your Curogram administrator.
Request Headers
Content-Type: application/json
Request Payload (JSON)
Required Fields
|
Field |
Type |
Description |
|
firstName |
string |
Patient's first name |
|
lastName |
string |
Patient's last name |
|
phoneNumber |
string |
Patient's phone number (E.164 format) |
|
dob |
string |
Date of birth (ISO format: YYYY-MM-DD) |
|
actionId |
string (UUID) |
Unique ID of the action to trigger |
Optional Fields
|
Field |
Type |
Description |
|
gender |
string |
Patient gender |
Example Request
{
"phoneNumber": "+13233064765",
"firstName": "Jason",
"lastName": "Bourne",
"dob": "2026-03-09",
"gender": "male",
"actionId": "550e8400-e29b-41d4-a716-446655440000"
}
Important Notes
✅ Date Format Requirement
- Must follow ISO format:
YYYY-MM-DD
✔ Correct: "2026-03-09"
❌ Incorrect: "03/09/2026"
✅ One Action per API Call
- Each request can only trigger one actionId
- To trigger multiple actions, send multiple API requests
✅ Phone Number Format
- Recommended format:
- +<country code> <number>
- Example: +13233064765
Typical Use Case (AI Receptionist)
Your AI system should:
- Collect user information during conversation:
- Name
- Phone number
- Date of birth
- Determine intent:
- Appointment request
- Billing inquiry
- Prescription refill
- etc.
- Map intent → actionId
- Send API request with collected data
Example Flow
User says:
“I want to schedule an appointment”
AI does:
- Maps intent → actionId = appointment_request_uuid
- Sends API request
What You Need From Curogram
- Your API endpoint
- Your configured Action IDs (UUIDs)
Final Thoughts
This integration allows your AI to go beyond conversation and take real action inside your workflow.
Once configured, your AI can:
- Automate patient intake
- Trigger workflows instantly
- Reduce manual staff workload