Update Campaign

curl --request PATCH \
  --url https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Q1 Payment Reminders v2",
  "end_timestamp": "2026-04-30T18:00:00Z",
  "allowed_schedule": {
    "timezone": "Asia/Kolkata",
    "allowed_start_time": "08:00",
    "allowed_end_time": "20:00",
    "allowed_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ]
  }
}
'

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",
    "end_timestamp": "2026-04-30T18:00:00Z",
    "allowed_schedule": {
        "timezone": "Asia/Kolkata",
        "allowed_start_time": "08:00",
        "allowed_end_time": "20:00",
        "allowed_days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Q1 Payment Reminders v2',
    end_timestamp: '2026-04-30T18:00:00Z',
    allowed_schedule: {
      timezone: 'Asia/Kolkata',
      allowed_start_time: '08:00',
      allowed_end_time: '20:00',
      allowed_days: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']
    }
  })
};

fetch('https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Q1 Payment Reminders v2',
    'end_timestamp' => '2026-04-30T18:00:00Z',
    'allowed_schedule' => [
        'timezone' => 'Asia/Kolkata',
        'allowed_start_time' => '08:00',
        'allowed_end_time' => '20:00',
        'allowed_days' => [
                'Monday',
                'Tuesday',
                'Wednesday',
                'Thursday',
                'Friday',
                'Saturday'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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  \"end_timestamp\": \"2026-04-30T18:00:00Z\",\n  \"allowed_schedule\": {\n    \"timezone\": \"Asia/Kolkata\",\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  }\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Q1 Payment Reminders v2\",\n  \"end_timestamp\": \"2026-04-30T18:00:00Z\",\n  \"allowed_schedule\": {\n    \"timezone\": \"Asia/Kolkata\",\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  }\n}")
  .asString();

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["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Q1 Payment Reminders v2\",\n  \"end_timestamp\": \"2026-04-30T18:00:00Z\",\n  \"allowed_schedule\": {\n    \"timezone\": \"Asia/Kolkata\",\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  }\n}"

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

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

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "data": {
      "details": {}
    }
  }
}

PATCH

orgs

{org_id}

workspaces

{workspace_id}

campaigns

{campaign_id}

Update Campaign

curl --request PATCH \
  --url https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Q1 Payment Reminders v2",
  "end_timestamp": "2026-04-30T18:00:00Z",
  "allowed_schedule": {
    "timezone": "Asia/Kolkata",
    "allowed_start_time": "08:00",
    "allowed_end_time": "20:00",
    "allowed_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ]
  }
}
'

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",
    "end_timestamp": "2026-04-30T18:00:00Z",
    "allowed_schedule": {
        "timezone": "Asia/Kolkata",
        "allowed_start_time": "08:00",
        "allowed_end_time": "20:00",
        "allowed_days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday"]
    }
}
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Q1 Payment Reminders v2',
    end_timestamp: '2026-04-30T18:00:00Z',
    allowed_schedule: {
      timezone: 'Asia/Kolkata',
      allowed_start_time: '08:00',
      allowed_end_time: '20:00',
      allowed_days: ['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday']
    }
  })
};

fetch('https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Q1 Payment Reminders v2',
    'end_timestamp' => '2026-04-30T18:00:00Z',
    'allowed_schedule' => [
        'timezone' => 'Asia/Kolkata',
        'allowed_start_time' => '08:00',
        'allowed_end_time' => '20:00',
        'allowed_days' => [
                'Monday',
                'Tuesday',
                'Wednesday',
                'Thursday',
                'Friday',
                'Saturday'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

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  \"end_timestamp\": \"2026-04-30T18:00:00Z\",\n  \"allowed_schedule\": {\n    \"timezone\": \"Asia/Kolkata\",\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  }\n}")

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

	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Q1 Payment Reminders v2\",\n  \"end_timestamp\": \"2026-04-30T18:00:00Z\",\n  \"allowed_schedule\": {\n    \"timezone\": \"Asia/Kolkata\",\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  }\n}")
  .asString();

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["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Q1 Payment Reminders v2\",\n  \"end_timestamp\": \"2026-04-30T18:00:00Z\",\n  \"allowed_schedule\": {\n    \"timezone\": \"Asia/Kolkata\",\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  }\n}"

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

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

{
  "error": {
    "message": "<string>",
    "type": "<string>",
    "code": "<string>",
    "data": {
      "details": {}
    }
  }
}

Partially updates a campaign’s configuration. At least one field must be provided. Only allowed when the campaign is in paused or scheduled status — pause an active campaign first, then apply your changes and resume. app_id and app_type are immutable and cannot be changed after creation. You may include them in app_config during an update, but their values must match what was set at creation time.

Updatable fields

Field	Notes
`name`	Max 50 characters; alphanumeric, hyphens, underscores, and spaces
`description`	Max 150 characters
`app_config`	Full replacement of the agent config. `app_id` and `app_type` must match existing values.
`end_timestamp`	Can be extended or shortened. Must remain at least 120 seconds after `start_timestamp` and within 30 days.
`allowed_schedule`	Full replacement of the business-hours window

To adjust the call rate mid-campaign: pause → update app_config.attempts_per_second → resume. No other fields need to be re-supplied.

Authorizations

X-API-Key

string

header

required

Path Parameters

org_id

string

required

workspace_id

string

required

campaign_id

string

required

Body

application/json

Request body for updating a campaign. Only allowed when the campaign is in paused or scheduled status.

name

string | null

Updated campaign name. Alphanumeric, hyphens, underscores and spaces allowed. Max 50 characters.

description

string | null

Updated campaign description. Max 150 characters.

Maximum string length: 150

app_config

AgentConfig · object | null

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

Show child attributes

end_timestamp

string<date-time> | null

Updated campaign end time (ISO 8601)

allowed_schedule

AllowedScheduleConfig · object | null

Updated schedule constraints

Show child attributes

Response

Successful Response

Summary metadata for a campaign, returned in list responses.

name

string

required

Name of the resource

Example:

"Q1 Payment Reminders"

campaign_id

string

required

Unique identifier for the campaign

Example:

"camp-a1b2c3d4"

status

enum<string>

required

Current status

Available options:

ended,

active,

paused,

scheduled,

cancelled

Example:

"scheduled"

app_id

string

required

ID of the agent

Example:

"payment-reminder-agent"

created_by

string

required

User who created this resource

Example:

"user@company.com"

created_at

string<date-time>

required

Timestamp when the resource was created (ISO 8601)

Example:

"2026-03-28T10:00:00Z"

updated_at

string<date-time>

required

Timestamp when the resource was last updated (ISO 8601)

Example:

"2026-03-28T10:00:00Z"

description

string | null

Optional description

Example:

"Outbound reminder calls for Q1 overdue accounts"

app_type

enum<string>

default:agent

Type of agent

Available options:

agent

Example:

"agent"

app_version

integer | null

Version of the agent to use

Example:

1

updated_by

string | null

User who last updated this resource

Example:

"user@example.com"

Get Campaign Update Campaign Status

Deployments

Campaigns

Instant Outbound

Analytics

BYOK (Bring Your Own Key) API

Update Campaign

Updatable fields

Authorizations

Path Parameters

Body

Response

​Updatable fields

Authorizations

Path Parameters

Body

Response

Updatable fields