Skip to main content
POST
/
api
/
v1
/
campaigns
/
{campaign_id}
/
pause
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.burki.dev/llms.txt

Use this file to discover all available pages before exploring further.

Pause a running campaign. In-progress calls will complete, but no new calls will be initiated.

​
Path Parameters

  • campaign_id (integer, required): The unique identifier of the campaign

​
Behavior

When you pause a campaign:
  • In-progress calls continue until completion
  • Pending contacts remain in queue
  • No new calls are initiated
  • Campaign status changes to paused

​
Response

Response
{
  "message": "Campaign paused successfully"
}

​
Example Code

cURL
curl -X POST "https://api.burki.dev/api/v1/campaigns/42/pause" \
  -H "Authorization: Bearer YOUR_API_KEY"
Python
import requests

response = requests.post(
    "https://api.burki.dev/api/v1/campaigns/42/pause",
    headers={"Authorization": "Bearer YOUR_API_KEY"}
)

if response.status_code == 200:
    print("Campaign paused successfully")
else:
    print(f"Error: {response.json()}")
JavaScript
const response = await fetch("https://api.burki.dev/api/v1/campaigns/42/pause", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY"
  }
});

if (response.ok) {
  console.log("Campaign paused successfully");
} else {
  const error = await response.json();
  console.error("Error:", error);
}

​
Error Responses

Status CodeDescription
400Campaign is not running
404Campaign not found

​
Resuming a Paused Campaign

To resume a paused campaign, use the Start Campaign endpoint. The campaign will continue from where it left off. 
curl -X POST "https://api.burki.dev/api/v1/campaigns/42/start" \
  -H "Authorization: Bearer YOUR_API_KEY"

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
campaign_id
integer
required

Response

Successful Response