Update campaign | Sarvam API Docs

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 = {
    "X-API-Key": "<your-api-key>",
    "Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(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
}

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.

Path parameters

org_idstringRequired

workspace_idstringRequired

campaign_idstringRequired

Request

This endpoint expects an object.

namestring or nullOptional

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

descriptionstring or nullOptional<=150 characters

Updated campaign description. Max 150 characters.

app_configobject or nullOptional

Updated agent configuration

webhook_configobject or nullOptional

Webhook configuration for call completion events

end_timestampdatetime or nullOptional

Updated campaign end time (ISO 8601)

allowed_scheduleobject or nullOptional

Updated schedule constraints

Response

Successful Response

namestring

Name of the resource

campaign_idstring

Unique identifier for the campaign

statusenum

Current status

Allowed values:

app_idstring

ID of the agent

created_bystring

User who created this resource

created_atdatetime

Timestamp when the resource was created (ISO 8601)

updated_atdatetime

Timestamp when the resource was last updated (ISO 8601)

descriptionstring or nullOptional

Optional description

app_typeenumOptional

Type of agent

Allowed values:

app_versioninteger or nullOptional

Version of the agent to use

updated_bystring or nullOptional

User who last updated this resource

Errors

422

Unprocessable Entity Error

Path parameters

Headers

Request

Response

Errors