Update an existing phone script.

PUT

https://host.com/v1/scripts/phone/:scriptId

PUT

/v1/scripts/phone/:scriptId

1 const url = 'https://host.com/v1/scripts/phone/scriptId';
2 const options = {
3   method: 'PUT',
4   headers: {'X-API-Key': '<apiKey>', 'Content-Type': 'application/json'},
5   body: '{"agentName":"string","greeting":"string","goodbye":"string","faqs":[{}]}'
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   "agentName": "string",
3   "greeting": "string",
4   "goodbye": "string",
5   "useCaseAssociations": [
6     {
7       "id": "string",
8       "order": 1,
9       "status": "active"
10     }
11   ],
12   "giveSurvey": true,
13   "faqs": [
14     {
15       "question": "string",
16       "answer": "string",
17       "details": "string"
18     }
19   ],
20   "postCallScripts": [
21     {
22       "textScriptId": "string",
23       "description": "string"
24     }
25   ],
26   "voicemail": "string",
27   "voice": "string",
28   "voiceProvider": {
29     "value": "string"
30   },
31   "knowledgeBase": {
32     "documentIds": [
33       "string"
34     ],
35     "documentTags": [
36       "string"
37     ]
38   },
39   "$type": "string",
40   "id": "string",
41   "type": "phone",
42   "direction": "string",
43   "name": "string",
44   "status": "string"
45 }

Authentication

X-API-Keystring

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

Path parameters

scriptIdstringRequiredformat: "uuid"

The unique identifier of the phone script to update.

Request

The updated phone script configuration.

agentNamestring or nullRequired

Gets or sets the agent name.

greetingstring or nullRequired

Gets or sets the greeting.

goodbyestring or nullRequired

Gets or sets the goodBye.

faqslist of objects or nullRequired

Gets or sets the faq.

namestring or nullOptional

Gets or sets the Name.

directionstring or nullOptional

Gets or sets the direction.

useCaseAssociationslist of objects or nullOptional

Gets or sets the UseCase associations.

voicemailstring or nullOptional

Gets or sets the voicemail.

voicestring or nullOptional

Gets or sets the voice.

voiceProviderobjectOptional

giveSurveybooleanOptional

Gets or sets the GiveSurvey indicator.

postCallScriptslist of objects or nullOptional

Gets or sets the list of post-call script actions to run after call ends.

knowledgeBaseobjectOptional

Response

agentNamestring or null

Gets or sets the agent's name.

greetingstring or null

Gets or sets the greeting.

goodbyestring or null

Gets or sets the goodBye.

useCaseAssociationslist of objects or null

Gets or sets the UseCase associations.

giveSurveyboolean

Gets or sets the GiveSurvey indicator.

faqslist of objects or null

Gets or sets the faq.

postCallScriptslist of objects or null