API Reference

Campaigns

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Cancel a campaign

campaigns.cancel(id) -> 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

class CampaignCancelResponse { success }

success: bool

Cancel a campaign

Ruby

HTTP

TypeScript

Python

Ruby

require "revox"

revox = Revox::Client.new(api_key: "My API Key")

response = revox.campaigns.cancel("id")

puts(response)

200 example

{
  "success": true
}

Returns Examples

200 example

{
  "success": true
}