Pause a running campaign
client.campaigns.pause(stringid, RequestOptionsoptions?): CampaignPauseResponse { success }
POST/campaigns/{id}/pause
Pause a running campaign so no further calls are placed. In-progress calls are allowed to finish; pending and scheduled calls are held until the campaign is resumed. Scheduled retry timers keep counting down, so a call resumed before its time fires on schedule, while one resumed after its time fires at the next available calling window.
Parameters
id: string
Returns
Pause a running campaign
import Revox from '@revoxai/sdk';
const client = new Revox({
apiKey: process.env['REVOX_API_KEY'], // This is the default and can be omitted
});
const response = await client.campaigns.pause('id');
console.log(response.success);{
"success": true
}Returns Examples
{
"success": true
}