Update Campaign

A campaign is created with `POST /api/v1/campaigns/create` and later adjusted with

PUT/api/v1/campaigns/{campaign_id}

Examples

Request

curl --request PUT \
  --url 'https://api.vaanii.ai/api/v1/campaigns/67a9cf2e-b936-45c7-9704-9fd410ba4e6d' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <your_api_key>' \
  --data '{"name":"Loan Renewal Campaign","campaign_type":"conversational","active_provider":"twilio","config_data":{"stt_provider":"deepgram","stt_language":"hi-IN","supported_languages":["hi-IN","en-IN"]},"timezone":"Asia/Kolkata"}'

Response

Possible HTTP status codes for this endpoint, with a representative response body for each. Select a status to preview it.

200 OKSuccessful response

{
  "id": "9b247c8a-6754-44b0-b9de-4788c315b057",
  "name": "Loan Renewal Campaign",
  "status": "active",
  "campaign_type": "conversational",
  "active_provider": "twilio",
  "timezone": "Asia/Kolkata",
  "config_data": {
    "stt_provider": "deepgram",
    "stt_language": "hi-IN",
    "supported_languages": [
      "hi-IN",
      "en-IN"
    ]
  },
  "webhook_url": "https://your-app.example.com/vaanii/call-completed"
}

PUT /api/v1/campaigns/{campaign_id}. This section documents the campaign configuration fields, grouped into the 12 areas below.

Creating or modifying campaigns requires campaign-editing permission on your account; otherwise the API responds 403 Forbidden.

Update Campaign

Sections in this guide