Update Campaign Status

curl --request PUT \
  --url https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "action": "pause"
}
'

import requests

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

payload = { "action": "pause" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({action: 'pause'})
};

fetch('https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}/status', 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}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'action' => 'pause'
  ]),
  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}/status"

	payload := strings.NewReader("{\n  \"action\": \"pause\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}/status")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"pause\"\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}/status")

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"pause\"\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": {}
    }
  }
}

PUT

orgs

{org_id}

workspaces

{workspace_id}

campaigns

{campaign_id}

status

Update Campaign Status

curl --request PUT \
  --url https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}/status \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "action": "pause"
}
'

import requests

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

payload = { "action": "pause" }
headers = {
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({action: 'pause'})
};

fetch('https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}/status', 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}/status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'action' => 'pause'
  ]),
  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}/status"

	payload := strings.NewReader("{\n  \"action\": \"pause\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}/status")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"pause\"\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}/status")

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

request = Net::HTTP::Put.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"pause\"\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": {}
    }
  }
}

Triggers an explicit status transition on a campaign by sending an action. ended and cancelled are terminal — once reached, no further transitions are possible. A campaign reaches ended automatically when its end_timestamp passes.

Transitions

Action	Allowed from	Resulting Status
`pause`	`scheduled`, `active`	`paused`
`resume`	`paused`	`scheduled`
`cancel`	`scheduled`, `active`, `paused`	`cancelled`

Actions

pause — Temporarily stops call dispatch. The campaign retains its queue; calls resume when you send resume. Use this before editing a campaign via PATCH /campaigns/{id}.
resume — Restarts dispatch from where it left off. Status returns to scheduled and activates automatically if within the campaign window.
cancel — Permanently stops the campaign. All pending calls are dropped. This cannot be undone.

To make changes to an active campaign: pause → update → resume. Pausing is instant and does not lose any queue state.

Authorizations

X-API-Key

string

header

required

Path Parameters

org_id

string

required

workspace_id

string

required

campaign_id

string

required

Body

application/json

action

enum<string>

required

The new status to set for the campaign

Available options:

pause,

resume,

cancel

Example:

"pause"

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"

Update Campaign Webhook Payload

Deployments

Campaigns

Instant Outbound

Analytics

BYOK (Bring Your Own Key) API

Update Campaign Status

Transitions

Actions

Authorizations

Path Parameters

Body

Response

​Transitions

​Actions

Authorizations

Path Parameters

Body

Response

Transitions

Actions