Skip to content
Get started

Delete a campaign

client.campaigns.delete(stringid, RequestOptionsoptions?): CampaignDeleteResponse { success }
DELETE/campaigns/{id}

Permanently delete a campaign and all its associated rows. This action is irreversible. In-progress calls will not be affected, but no new calls will be placed.

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

Delete 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 campaign = await client.campaigns.delete('id');

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