Skip to content
Get started

Pause a running campaign

campaigns.pause(strid) -> CampaignPauseResponse
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: str
ReturnsExpand Collapse
class CampaignPauseResponse:
success: bool

Pause a running campaign

import os
from revox import Revox

client = Revox(
    api_key=os.environ.get("REVOX_API_KEY"),  # This is the default and can be omitted
)
response = client.campaigns.pause(
    "id",
)
print(response.success)
{
  "success": true
}
Returns Examples
{
  "success": true
}