Create a new email script for automated email campaigns.

POST

https://host.com/v1/scripts/email

POST

/v1/scripts/email

1 const url = 'https://host.com/v1/scripts/email';
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   "subject": "Appointment Confirmation",
3   "body": "Dear Sarah Chen,\n\nYour appointment with Marcus Johnson is confirmed for April 28th at 3:00 PM. Please reply if you need to reschedule.\n\nBest regards,\nCustomer Support Team",
4   "$type": "EmailScript",
5   "id": "d3b07384-d9a1-4f2a-9f3e-1a2b3c4d5e6f",
6   "type": "phone",
7   "direction": "outbound",
8   "name": "Appointment Confirmation Script",
9   "status": "active"
10 }

Authentication

X-API-Keystring

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

Request

The email script configuration.

namestring or nullOptional

Gets or sets the Name.

directionstring or nullOptional

Gets or sets the direction.

subjectstring or nullOptional

Gets or sets the subject.

bodystring or nullOptional

Gets or sets the body.

Response

Created

subjectstring or nullOptional

Gets or sets the subject.

bodystring or nullOptional

Gets or sets the body.

Errors

400

Bad Request Error