Cancel a campaign

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.

Request

curl -X POST "https://www.getrevox.com/api/campaigns/9b2d7e41-6c3f-4a8e-b5d0-2f7a1c9e4b63/cancel" \
  -H "Authorization: Bearer $REVOX_API_KEY"

const res = await fetch("https://www.getrevox.com/api/campaigns/9b2d7e41-6c3f-4a8e-b5d0-2f7a1c9e4b63/cancel", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.REVOX_API_KEY}`,
  },
});
const data = await res.json();
console.log(data);

import os

import requests

response = requests.post(
    "https://www.getrevox.com/api/campaigns/9b2d7e41-6c3f-4a8e-b5d0-2f7a1c9e4b63/cancel",
    headers={"Authorization": f"Bearer {os.environ['REVOX_API_KEY']}"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

Try itSend this request live

Response

Success

{ "success": true }

{ "error": "Not found" }

Path parameters

idstringrequired
ID of the campaign, as returned by GET /campaigns.

Request body

No body: send the request without one.

Response

200

successboolean
True when the operation succeeded.

Errors

404Not found in your organization{ "error": string }

Error bodies carry an error (or message) string; a 400 adds bodyErrors.issues. See Errors.