Skip to content
Get started

Cancel a campaign

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

ParametersExpand Collapse
id: str
ReturnsExpand Collapse
class CampaignCancelResponse:
success: bool

Cancel a 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.cancel(
    "id",
)
print(response.success)
{
  "success": true
}
Returns Examples
{
  "success": true
}