API Reference

Campaigns

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Pause a running campaign

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

ParametersExpand Collapse

id: String

ReturnsExpand Collapse

class CampaignPauseResponse { success }

success: bool

Pause a running campaign

Ruby

HTTP

TypeScript

Python

Ruby

require "revox"

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

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

puts(response)

200 example

{
  "success": true
}

Returns Examples

200 example

{
  "success": true
}