> 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 status

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

Change the status of a campaign by sending a `pause`, `resume`, or `cancel` action.

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

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: agents
  version: 1.0.0
paths:
  /v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns/{campaign_id}/status:
    put:
      operationId: update-campaign-status
      summary: Update Campaign Status
      description: >-
        Change the status of a campaign by sending a `pause`, `resume`, or
        `cancel` action.
      tags:
        - v1-campaigns
      parameters:
        - name: org_id
          in: path
          required: true
          schema:
            type: string
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
        - name: campaign_id
          in: path
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignMetadata'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateCampaignStatus'
servers:
  - url: https://apps.sarvam.ai/api/scheduling
    description: Production
components:
  schemas:
    CampaignAction:
      type: string
      enum:
        - pause
        - resume
        - cancel
      title: CampaignAction
    UpdateCampaignStatus:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/CampaignAction'
          description: The new status to set for the campaign
      required:
        - action
      title: UpdateCampaignStatus
    CampaignStatus:
      type: string
      enum:
        - ended
        - active
        - paused
        - scheduled
        - cancelled
      description: >-
        Campaign lifecycle status: `scheduled` → `active` → `ended`. Can be
        `paused` or `cancelled` at any point.
      title: CampaignStatus
    AppType:
      type: string
      enum:
        - agent
      title: AppType
    CampaignMetadata:
      type: object
      properties:
        name:
          type: string
          description: Name of the resource
        campaign_id:
          type: string
          description: Unique identifier for the campaign
        status:
          $ref: '#/components/schemas/CampaignStatus'
          description: Current status
        description:
          type:
            - string
            - 'null'
          description: Optional description
        app_id:
          type: string
          description: ID of the agent
        app_type:
          $ref: '#/components/schemas/AppType'
          description: Type of agent
        app_version:
          type:
            - integer
            - 'null'
          description: Version of the agent to use
        created_by:
          type: string
          description: User who created this resource
        created_at:
          type: string
          format: date-time
          description: Timestamp when the resource was created (ISO 8601)
        updated_by:
          type:
            - string
            - 'null'
          description: User who last updated this resource
        updated_at:
          type: string
          format: date-time
          description: Timestamp when the resource was last updated (ISO 8601)
      required:
        - name
        - campaign_id
        - status
        - app_id
        - created_by
        - created_at
        - updated_at
      description: Summary metadata for a campaign, returned in list responses.
      title: CampaignMetadata
    ErrorBody:
      type: object
      properties:
        code:
          type: string
          description: A service-specific error code.
        message:
          type: string
          description: A human-readable description of the error.
      required:
        - code
        - message
      description: Details of the error that occurred.
      title: ErrorBody
    ErrorResponse:
      type: object
      properties:
        error:
          $ref: '#/components/schemas/ErrorBody'
      required:
        - error
      description: A standard wrapper for all error responses.
      title: ErrorResponse

```

## Examples



**Request**

```json
{
  "action": "pause"
}
```

**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/status"

payload = { "action": "pause" }
headers = {"Content-Type": "application/json"}

response = requests.put(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/status';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: '{"action":"pause"}'
};

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/status"

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

	req, _ := http.NewRequest("PUT", 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/status")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"action\": \"pause\"\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.put("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id/status")
  .header("Content-Type", "application/json")
  .body("{\n  \"action\": \"pause\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns/campaign_id/status', [
  'body' => '{
  "action": "pause"
}',
  '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/status");
var request = new RestRequest(Method.PUT);
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"action\": \"pause\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["Content-Type": "application/json"]
let parameters = ["action": "pause"] 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/status")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
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()
```