Create a new campaign.

POST

https://host.com/v1/campaigns

X-API-Keystring

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

The campaign configuration including sequences, contact lists, and redialing rules.

namestring or nullOptional

descriptionstring or nullOptional

sequenceslist of objects or nullOptional

redialingRulesstring or nullOptionalformat: "uuid"

contactListslist of objects or nullOptional

Created

idstringOptionalformat: "uuid"

namestring or nullOptional

descriptionstring or nullOptional

statusstring or nullOptional

sequenceslist of objects or nullOptional

redialingRulesstring or nullOptionalformat: "uuid"

contactListslist of objects or nullOptional

createdAtstring or nullOptional

400

Bad Request Error

1	const url = 'https://host.com/v1/campaigns';
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	}