Start a campaign to begin outreach to contacts. The campaign will begin processing contacts according to its sequences.

X-API-Keystring

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

idstringRequiredformat: "uuid"

The unique identifier of the campaign to start.

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

404

Not Found Error

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