> For clean Markdown of any page, append `.md` to the page URL.
> For a complete documentation index, see https://docs.sarvam.ai/llms.txt.
> For full documentation content in one file, see https://docs.sarvam.ai/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.sarvam.ai/_mcp/server.

# Update campaign

PATCH https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}
Content-Type: application/json

Update a campaign's configuration. Only allowed when the campaign is in `paused` or `scheduled` status.

You can update the name, description, agent configuration, end timestamp, and allowed schedule.

Reference: https://docs.sarvam.ai/api-reference/campaigns/update

## Request

### Path parameters

- `org_id` (string, required)
- `workspace_id` (string, required)
- `campaign_id` (string, required)

### Body (application/json)

This endpoint expects an UpdateCampaign.

- `name` (string, optional, nullable) — Updated campaign name. Alphanumeric, hyphens, underscores and spaces allowed. Max 50 characters.
- `description` (string, optional, nullable) — Updated campaign description. Max 150 characters.
- `app_config` (AgentConfig-Input, optional, nullable) — Updated agent configuration
- `webhook_config` (WebhookConfig, optional, nullable) — Webhook configuration for call completion events
- `end_timestamp` (datetime, optional, nullable) — Updated campaign end time (ISO 8601)
- `allowed_schedule` (AllowedScheduleConfig, optional, nullable) — Updated schedule constraints

## Response

### 200

Successful Response

- `name` (string, required) — Name of the resource
- `campaign_id` (string, required) — Unique identifier for the campaign
- `status` (enum, required) — Current status
  - Allowed values: `ended`, `active`, `paused`, `scheduled`, `cancelled`
- `app_id` (string, required) — ID of the agent
- `created_by` (string, required) — User who created this resource
- `created_at` (datetime, required) — Timestamp when the resource was created (ISO 8601)
- `updated_at` (datetime, required) — Timestamp when the resource was last updated (ISO 8601)
- `description` (string, optional, nullable) — Optional description
- `app_type` (enum, optional) — Type of agent
  - Allowed values: `agent`
- `app_version` (integer, optional, nullable) — Version of the agent to use
- `updated_by` (string, optional, nullable) — User who last updated this resource

## Errors

### 422 Unprocessable Entity Error

Validation Error

- `error` (ErrorBody, required) — Details of the error that occurred.

## Types

### AgentConfig-Input

Agent configuration including rate limiting, telephony connections, and retry policy.

- `app_id` (string, required) — ID of the agent
- `app_version` (integer, required) — Version of the agent to use
- `attempts_per_second` (double, required) — Rate of outbound call attempts (dials) per second. Every dial counts — initial calls and retries alike. Range: 0.1–500.
- `connection_configs` (list of ConnectionConfig, required) — Telephony connection configurations with phone numbers
- `retry_config` (RetryConfig-Input, required) — Retry configuration for failed or unanswered calls
- `app_type` ("agent", optional, default: agent) — Always `agent`
- `phone_rotation` (AgentConfigInputPhoneRotation, optional) — Phone number rotation configuration. Set `agent` to `true` so every subsequent call to the same user uses a different agent number until each number in the pool has been used once for that user. Requires at least two numbers in `connection_configs[].phone_numbers`.

### WebhookConfig

- `url` (string, required)
- `metadata` (map from string to any, optional, nullable)

### AllowedScheduleConfig

Business hours configuration defining when a campaign can make calls.

- `allowed_start_time` (string, required) — Start time in HH:MM 24-hour format
- `allowed_end_time` (string, required) — End time in HH:MM 24-hour format
- `allowed_days` (list of enum, required) — Days of the week when the campaign can run
  - Allowed values: `Monday`, `Tuesday`, `Wednesday`, `Thursday`, `Friday`, `Saturday`, `Sunday`
- `timezone` (string, optional) — IANA timezone, e.g. 'Asia/Kolkata', 'UTC', 'America/New_York'

### ErrorBody

Details of the error that occurred.

- `code` (string, required) — A service-specific error code.
- `message` (string, required) — A human-readable description of the error.

### ConnectionConfig

- `connection_id` (string, required)
- `agent_phone_number` (string, required)

### RetryConfig-Input

Retry policy defining how failed or unanswered calls are retried.

- `max_retries` (integer, required) — Maximum number of retry attempts (0 to 20)
- `retry_on` (RetryOnConfig, optional) — Conditions that trigger a retry
- `retry_interval_minutes` (RetryConfigInputRetryIntervalMinutes, optional) — Minutes to wait between retries. Can be a single value or an array for variable intervals.

### AgentConfigInputPhoneRotation

Phone number rotation configuration. Set `agent` to `true` so every subsequent call to the same user uses a different agent number until each number in the pool has been used once for that user. Requires at least two numbers in `connection_configs[].phone_numbers`.

- `agent` (boolean, optional, default: false) — Enable phone number rotation for agent campaigns

### RetryOnConfig

Granular retry conditions for different call outcomes (busy, failed, no answer, short duration, errors).

- `busy` (BaseRetryConfig, optional, nullable) — Retry when the line is busy
- `failed` (BaseRetryConfig, optional, nullable) — Retry when the call fails
- `no_answer` (BaseRetryConfig, optional, nullable) — Retry when there is no answer
- `short_duration` (ShortDurationRetryConfig, optional, nullable) — Retry when the call duration is below a threshold
- `provider_error` (ErrorRetryConfig, optional, nullable) — Retry on telephony provider errors
- `internal_error` (ErrorRetryConfig, optional, nullable, default: {"enabled":true,"max_retries":3,"retry_interval_minutes":5}) — Retry on internal system errors

### RetryConfigInputRetryIntervalMinutes

Minutes to wait between retries. Can be a single value or an array for variable intervals.

### BaseRetryConfig

- `enabled` (boolean, required) — Whether this retry condition is enabled

### ShortDurationRetryConfig

- `enabled` (boolean, required) — Whether short duration retry is enabled
- `threshold_seconds` (integer, required, default: 30) — Calls shorter than this duration (in seconds) will be retried

### ErrorRetryConfig

- `enabled` (boolean, required) — Whether error retry is enabled
- `max_retries` (integer, required, default: 3) — Maximum number of retries for this error type (1 to 20)
- `retry_interval_minutes` (integer, required, default: 5) — Minutes to wait between retries (minimum 5)

## Examples

**Request**

```json
{
  "name": "Q1 Payment Reminders v2",
  "webhook_config": {
    "url": "https://api.example.com/webhooks/campaign-events",
    "metadata": {
      "ref": "q1-reminders-v2"
    }
  },
  "end_timestamp": "2026-04-30T18:00:00Z",
  "allowed_schedule": {
    "allowed_start_time": "08:00",
    "allowed_end_time": "20:00",
    "allowed_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ],
    "timezone": "Asia/Kolkata"
  }
}
```

**Response**

```json
{
  "name": "Q1 Payment Reminders",
  "campaign_id": "camp-a1b2c3d4",
  "status": "scheduled",
  "app_id": "payment-reminder-agent",
  "created_by": "user@company.com",
  "created_at": "2026-03-28T10:00:00Z",
  "updated_at": "2026-03-28T10:00:00Z",
  "description": "Remind customers about upcoming payment due dates",
  "app_type": "agent",
  "app_version": 2,
  "updated_by": null
}
```

**SDK Code**

```python
import requests

url = "https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id"

payload = {
    "name": "Q1 Payment Reminders v2",
    "webhook_config": {
        "url": "https://api.example.com/webhooks/campaign-events",
        "metadata": { "ref": "q1-reminders-v2" }
    },
    "end_timestamp": "2026-04-30T18:00:00Z",
    "allowed_schedule": {
        "allowed_start_time": "08:00",
        "allowed_end_time": "20:00",
        "allowed_days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"],
        "timezone": "Asia/Kolkata"
    }
}
headers = {"Content-Type": "application/json"}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json'},
  body: '{"name":"Q1 Payment Reminders v2","webhook_config":{"url":"https://api.example.com/webhooks/campaign-events","metadata":{"ref":"q1-reminders-v2"}},"end_timestamp":"2026-04-30T18:00:00Z","allowed_schedule":{"allowed_start_time":"08:00","allowed_end_time":"20:00","allowed_days":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday"],"timezone":"Asia/Kolkata"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id"

	payload := strings.NewReader("{\n  \"name\": \"Q1 Payment Reminders v2\",\n  \"webhook_config\": {\n    \"url\": \"https://api.example.com/webhooks/campaign-events\",\n    \"metadata\": {\n      \"ref\": \"q1-reminders-v2\"\n    }\n  },\n  \"end_timestamp\": \"2026-04-30T18:00:00Z\",\n  \"allowed_schedule\": {\n    \"allowed_start_time\": \"08:00\",\n    \"allowed_end_time\": \"20:00\",\n    \"allowed_days\": [\n      \"Monday\",\n      \"Tuesday\",\n      \"Wednesday\",\n      \"Thursday\",\n      \"Friday\",\n      \"Saturday\"\n    ],\n    \"timezone\": \"Asia/Kolkata\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Q1 Payment Reminders v2\",\n  \"webhook_config\": {\n    \"url\": \"https://api.example.com/webhooks/campaign-events\",\n    \"metadata\": {\n      \"ref\": \"q1-reminders-v2\"\n    }\n  },\n  \"end_timestamp\": \"2026-04-30T18:00:00Z\",\n  \"allowed_schedule\": {\n    \"allowed_start_time\": \"08:00\",\n    \"allowed_end_time\": \"20:00\",\n    \"allowed_days\": [\n      \"Monday\",\n      \"Tuesday\",\n      \"Wednesday\",\n      \"Thursday\",\n      \"Friday\",\n      \"Saturday\"\n    ],\n    \"timezone\": \"Asia/Kolkata\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Q1 Payment Reminders v2\",\n  \"webhook_config\": {\n    \"url\": \"https://api.example.com/webhooks/campaign-events\",\n    \"metadata\": {\n      \"ref\": \"q1-reminders-v2\"\n    }\n  },\n  \"end_timestamp\": \"2026-04-30T18:00:00Z\",\n  \"allowed_schedule\": {\n    \"allowed_start_time\": \"08:00\",\n    \"allowed_end_time\": \"20:00\",\n    \"allowed_days\": [\n      \"Monday\",\n      \"Tuesday\",\n      \"Wednesday\",\n      \"Thursday\",\n      \"Friday\",\n      \"Saturday\"\n    ],\n    \"timezone\": \"Asia/Kolkata\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id', [
  'body' => '{
  "name": "Q1 Payment Reminders v2",
  "webhook_config": {
    "url": "https://api.example.com/webhooks/campaign-events",
    "metadata": {
      "ref": "q1-reminders-v2"
    }
  },
  "end_timestamp": "2026-04-30T18:00:00Z",
  "allowed_schedule": {
    "allowed_start_time": "08:00",
    "allowed_end_time": "20:00",
    "allowed_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ],
    "timezone": "Asia/Kolkata"
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Q1 Payment Reminders v2\",\n  \"webhook_config\": {\n    \"url\": \"https://api.example.com/webhooks/campaign-events\",\n    \"metadata\": {\n      \"ref\": \"q1-reminders-v2\"\n    }\n  },\n  \"end_timestamp\": \"2026-04-30T18:00:00Z\",\n  \"allowed_schedule\": {\n    \"allowed_start_time\": \"08:00\",\n    \"allowed_end_time\": \"20:00\",\n    \"allowed_days\": [\n      \"Monday\",\n      \"Tuesday\",\n      \"Wednesday\",\n      \"Thursday\",\n      \"Friday\",\n      \"Saturday\"\n    ],\n    \"timezone\": \"Asia/Kolkata\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = [
  "name": "Q1 Payment Reminders v2",
  "webhook_config": [
    "url": "https://api.example.com/webhooks/campaign-events",
    "metadata": ["ref": "q1-reminders-v2"]
  ],
  "end_timestamp": "2026-04-30T18:00:00Z",
  "allowed_schedule": [
    "allowed_start_time": "08:00",
    "allowed_end_time": "20:00",
    "allowed_days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"],
    "timezone": "Asia/Kolkata"
  ]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```