## Cancel

`client.campaigns.cancel(stringid, RequestOptionsoptions?): CampaignCancelResponse`

**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.

### Parameters

- `id: string`

### Returns

- `CampaignCancelResponse`

  - `success: boolean`

### Example

```typescript
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);
```