Update an existing sequence.

PUT

https://host.com/v1/sequences/:id

PUT

/v1/sequences/:id

1 const url = 'https://host.com/v1/sequences/id';
2 const options = {
3   method: 'PUT',
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": "string",
3   "status": "string",
4   "name": "string",
5   "description": "string",
6   "criteria": "string",
7   "schedules": [
8     {
9       "dayOffset": 1,
10       "hour": 1,
11       "minute": 1,
12       "delayInMinutes": 1,
13       "phoneScript": {
14         "agentName": "string",
15         "greeting": "string",
16         "goodbye": "string",
17         "useCaseAssociations": [
18           {
19             "id": "string",
20             "order": 1,
21             "status": "active"
22           }
23         ],
24         "giveSurvey": true,
25         "faqs": [
26           {
27             "question": "string",
28             "answer": "string",
29             "details": "string"
30           }
31         ],
32         "postCallScripts": [
33           {
34             "textScriptId": "string",
35             "description": "string"
36           }
37         ],
38         "voicemail": "string",
39         "voice": "string",
40         "voiceProvider": {
41           "value": "string"
42         },
43         "knowledgeBase": {
44           "documentIds": [
45             "string"
46           ],
47           "documentTags": [
48             "string"
49           ]
50         },
51         "$type": "string",
52         "id": "string",
53         "type": "phone",
54         "direction": "string",
55         "name": "string",
56         "status": "string"
57       },
58       "emailScript": {
59         "subject": "string",
60         "body": "string",
61         "$type": "string",
62         "id": "string",
63         "type": "phone",
64         "direction": "string",
65         "name": "string",
66         "status": "string"
67       },
68       "textScript": {
69         "message": "string",
70         "$type": "string",
71         "id": "string",
72         "type": "phone",
73         "direction": "string",
74         "name": "string",
75         "status": "string"
76       },
77       "blasterScript": {
78         "message": "string",
79         "$type": "string",
80         "id": "string",
81         "type": "phone",
82         "direction": "string",
83         "name": "string",
84         "status": "string"
85       },
86       "scripts": [
87         {
88           "subject": "string",
89           "body": "string",
90           "$type": "string",
91           "id": "string",
92           "type": "phone",
93           "direction": "string",
94           "name": "string",
95           "status": "string"
96         }
97       ]
98     }
99   ],
100   "timezone": "string"
101 }

Authentication

X-API-Keystring

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

Path parameters

idstringRequiredformat: "uuid"

The unique identifier of the sequence to update.

Request

The updated sequence configuration.

namestring or nullOptional

descriptionstring or nullOptional

criteriastring or nullOptional

scheduleslist of objects or nullOptional

timezonestring or nullOptional

Response

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