Create a new sequence.

POST

https://host.com/v1/sequences

POST

/v1/sequences

1 const url = 'https://host.com/v1/sequences';
2 const options = {
3   method: 'POST',
4   headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{}'
6 };
7 
8 try {
9   const response = await fetch(url, options);
10   const data = await response.json();
11   console.log(data);
12 } catch (error) {
13   console.error(error);
14 }

1 {
2   "id": "a3f1c9d2-4b7e-4f8a-9c3d-2e5b7f6a8d9e",
3   "status": "active",
4   "name": "Appointment Reminder Sequence",
5   "description": "Sequence to remind customers about upcoming appointments and follow up for feedback.",
6   "criteria": "contact.status == 'active' AND contact.hasUpcomingAppointment == true",
7   "schedules": [
8     {
9       "dayOffset": 0,
10       "hour": 9,
11       "minute": 0,
12       "delayInMinutes": 0,
13       "phoneScript": {
14         "agentName": "Sarah Chen",
15         "greeting": "Hello, this is Sarah from Acme Health. We're calling to remind you of your appointment scheduled for tomorrow.",
16         "goodbye": "Thank you for your time. Have a great day!",
17         "useCaseAssociations": [
18           {
19             "id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f70",
20             "order": 1,
21             "status": "active"
22           }
23         ],
24         "giveSurvey": true,
25         "faqs": [
26           {
27             "question": "What should I bring to my appointment?",
28             "answer": "Please bring a valid ID and your insurance card.",
29             "details": "If you have any recent medical records, please bring those as well."
30           }
31         ],
32         "postCallScripts": [
33           {
34             "textScriptId": "f1e2d3c4-b5a6-7890-1234-56789abcdef0",
35             "description": "Send follow-up SMS with appointment details."
36           }
37         ],
38         "voicemail": "Hi, this is Sarah from Acme Health. We wanted to remind you about your appointment tomorrow. Please call us back if you need to reschedule.",
39         "voice": "female",
40         "voiceProvider": {
41           "value": "Amazon Polly - Joanna"
42         },
43         "knowledgeBase": {
44           "documentIds": [
45             "123e4567-e89b-12d3-a456-426614174000"
46           ],
47           "documentTags": [
48             "appointment",
49             "reminder",
50             "healthcare"
51           ]
52         },
53         "$type": "PhoneScript",
54         "id": "b7c8d9e0-f1a2-3456-7890-abcdef123456",
55         "type": "phone",
56         "direction": "outbound",
57         "name": "Appointment Reminder Call Script",
58         "status": "active"
59       },
60       "emailScript": {
61         "subject": "Reminder: Your Appointment is Tomorrow",
62         "body": "Dear Marcus Johnson,\n\nThis is a friendly reminder that you have an appointment scheduled for tomorrow at 10:00 AM.\n\nPlease let us know if you need to reschedule.\n\nBest regards,\nAcme Health Team",
63         "$type": "EmailScript",
64         "id": "c1d2e3f4-a5b6-7890-cdef-1234567890ab",
65         "type": "phone",
66         "direction": "outbound",
67         "name": "Appointment Reminder Email",
68         "status": "active"
69       },
70       "textScript": {
71         "message": "Hi Marcus, this is a reminder from Acme Health about your appointment tomorrow at 10 AM. Reply YES to confirm or call us to reschedule.",
72         "$type": "TextScript",
73         "id": "d2e3f4a5-b678-90cd-ef12-34567890abcd",
74         "type": "phone",
75         "direction": "outbound",
76         "name": "Appointment Reminder SMS",
77         "status": "active"
78       },
79       "blasterScript": {
80         "message": "Reminder: Your appointment at Acme Health is scheduled for tomorrow. Please confirm or reschedule.",
81         "$type": "BlasterScript",
82         "id": "e3f4a5b6-7890-cdef-1234-567890abcdef",
83         "type": "phone",
84         "direction": "outbound",
85         "name": "Appointment Reminder Blaster",
86         "status": "active"
87       },
88       "scripts": [
89         {
90           "subject": "Follow-up: How was your appointment?",
91           "body": "Dear Marcus Johnson,\n\nWe hope your appointment went well. Please take a moment to provide feedback on your experience.\n\nThank you,\nAcme Health Team",
92           "$type": "EmailScript",
93           "id": "f4a5b678-90cd-ef12-3456-7890abcdef12",
94           "type": "phone",
95           "direction": "outbound",
96           "name": "Post-Appointment Feedback Email",
97           "status": "active"
98         }
99       ]
100     }
101   ],
102   "timezone": "America/New_York"
103 }

Authentication

X-API-Keystring

API Key authentication. Generate your API key in the Gail Portal under General > Integrations > API Keys.

Request

The sequence configuration including steps and schedules.

namestring or nullOptional

descriptionstring or nullOptional

criteriastring or nullOptional

scheduleslist of objects or nullOptional

timezonestring or nullOptional

Response

Created

idstringOptionalformat: "uuid"

statusstring or nullOptional

namestring or nullOptional

descriptionstring or nullOptional

criteriastring or nullOptional

scheduleslist of objects or nullOptional

timezonestring or nullOptional

Errors

400

Bad Request Error