Update Campaign

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PUT

api

campaigns

{campaign_id}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Update an existing campaign’s configuration. Only campaigns in draft or paused status can be updated.

Running or completed campaigns cannot be updated. Pause the campaign first if you need to make changes.

Path Parameters

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

Request Body

All fields are optional. Only include fields you want to update.

Field	Type	Description
`name`	string	Campaign name (1-200 characters)
`description`	string	Campaign description
`welcome_message_template`	string	Template for welcome message
`agenda_template`	string	Template for call agenda
`end_call_message_template`	string	Template for end call message
`sms_message_template`	string	Template for SMS content
`fallback_values`	object	Fallback values for missing variables
`max_attempts`	integer	Max retry attempts
`retry_delay_minutes`	integer	Delay between retries

Example Request

Request Body

{
  "name": "Updated Campaign Name",
  "agenda_template": "I'm calling about your upcoming appointment on {{appointment_date}} at {{appointment_time}}.",
  "max_attempts": 5
}

Response

Returns a success message when the update is complete.

Response

{
  "message": "Campaign updated successfully"
}

Example Code

cURL

curl -X PUT "https://api.burki.dev/api/v1/campaigns/42" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Updated Campaign Name",
    "max_attempts": 5
  }'

Python

import requests

response = requests.put(
    "https://api.burki.dev/api/v1/campaigns/42",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={
        "name": "Updated Campaign Name",
        "max_attempts": 5
    }
)

result = response.json()
print(result["message"])

JavaScript

const response = await fetch("https://api.burki.dev/api/v1/campaigns/42", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    name: "Updated Campaign Name",
    max_attempts: 5
  })
});

const result = await response.json();
console.log(result.message);

Error Responses

Status Code	Description
400	Cannot update running or completed campaigns
404	Campaign not found
401	Unauthorized - invalid or missing 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

Body

application/json

Request model for updating a campaign.

name

string | null

description

string | null

welcome_message_template

string | null

agenda_template

string | null

end_call_message_template

string | null

sms_message_template

string | null

max_attempts

integer | null

retry_delay_minutes

integer | null

fallback_values

Fallback Values · object | null

Show child attributes

variable_mappings

Variable Mappings · object | null

Show child attributes

available_variables

string[] | null

pending_import

Pending Import · object | null

Response

Successful Response

API Documentation

Assistants

Assistant Phone Numbers

Assistant Documents (RAG)

Voice Cloning

Calls

Messaging

SIP Trunks

Billing

Phone Number Management

Call Data

Organization

Webhooks & System

Campaigns

WebSockets

Tools & Custom Actions

Conversation Flows

Learning & Memory

Path Parameters

Request Body

Example Request

Response

Example Code

Error Responses

Authorizations

Path Parameters

Body

Response

​Path Parameters

​Request Body

​Example Request

​Response

​Example Code

​Error Responses

Authorizations

Path Parameters

Body

Response

Path Parameters

Request Body

Example Request

Response

Example Code

Error Responses