Skip to content
revox
Get started
API Reference
Campaigns

Cancel a campaign

client.campaigns.cancel(stringid, RequestOptionsoptions?): CampaignCancelResponse { success }
POST/campaigns/{id}/cancel

Cancel a running or scheduled campaign. Pending and queued calls will be aborted, while in-progress calls will be allowed to finish. Unlike deletion, the campaign and its rows are preserved for historical reference.

ParametersExpand Collapse
id: string
ReturnsExpand Collapse
CampaignCancelResponse { success }
success: boolean

Cancel a 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.cancel('id');

console.log(response.success);
{
  "success": true
}
Returns Examples
{
  "success": true
}