> 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. # Create campaign POST https://apps.sarvam.ai/api/scheduling/v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns Content-Type: application/json Create a new campaign that ties an agent to a schedule, rate, and retry policy. The campaign will be created in `scheduled` status. It starts automatically when `start_timestamp` is reached. Reference: https://docs.sarvam.ai/api-reference/campaigns/create ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: agents version: 1.0.0 paths: /v1/orgs/{org_id}/workspaces/{workspace_id}/campaigns: post: operationId: create-campaign summary: Create Campaign description: >- Create a new campaign that ties an agent to a schedule, rate, and retry policy. The campaign will be created in `scheduled` status. It starts automatically when `start_timestamp` is reached. tags: - v1-campaigns parameters: - name: org_id in: path required: true schema: type: string - name: workspace_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/CreateCampaign' servers: - url: https://apps.sarvam.ai/api/scheduling description: Production components: schemas: ConnectionConfig: type: object properties: connection_id: type: string agent_phone_number: type: string required: - connection_id - agent_phone_number title: ConnectionConfig BaseRetryConfig: type: object properties: enabled: type: boolean description: Whether this retry condition is enabled required: - enabled title: BaseRetryConfig ShortDurationRetryConfig: type: object properties: enabled: type: boolean description: Whether short duration retry is enabled threshold_seconds: type: integer default: 30 description: Calls shorter than this duration (in seconds) will be retried required: - enabled - threshold_seconds title: ShortDurationRetryConfig ErrorRetryConfig: type: object properties: enabled: type: boolean description: Whether error retry is enabled max_retries: type: integer default: 3 description: Maximum number of retries for this error type (1 to 20) retry_interval_minutes: type: integer default: 5 description: Minutes to wait between retries (minimum 5) required: - enabled - max_retries - retry_interval_minutes title: ErrorRetryConfig RetryOnConfig: type: object properties: busy: oneOf: - $ref: '#/components/schemas/BaseRetryConfig' - type: 'null' description: Retry when the line is busy failed: oneOf: - $ref: '#/components/schemas/BaseRetryConfig' - type: 'null' description: Retry when the call fails no_answer: oneOf: - $ref: '#/components/schemas/BaseRetryConfig' - type: 'null' description: Retry when there is no answer short_duration: oneOf: - $ref: '#/components/schemas/ShortDurationRetryConfig' - type: 'null' description: Retry when the call duration is below a threshold provider_error: oneOf: - $ref: '#/components/schemas/ErrorRetryConfig' - type: 'null' description: Retry on telephony provider errors internal_error: oneOf: - $ref: '#/components/schemas/ErrorRetryConfig' - type: 'null' default: enabled: true max_retries: 3 retry_interval_minutes: 5 description: Retry on internal system errors description: >- Granular retry conditions for different call outcomes (busy, failed, no answer, short duration, errors). title: RetryOnConfig RetryConfigInputRetryIntervalMinutes: oneOf: - type: integer - type: array items: type: integer description: >- Minutes to wait between retries. Can be a single value or an array for variable intervals. title: RetryConfigInputRetryIntervalMinutes RetryConfig-Input: type: object properties: max_retries: type: integer description: Maximum number of retry attempts (0 to 20) retry_on: $ref: '#/components/schemas/RetryOnConfig' description: Conditions that trigger a retry retry_interval_minutes: $ref: '#/components/schemas/RetryConfigInputRetryIntervalMinutes' description: >- Minutes to wait between retries. Can be a single value or an array for variable intervals. required: - max_retries description: Retry policy defining how failed or unanswered calls are retried. title: RetryConfig-Input WebhookConfig: type: object properties: url: type: string metadata: type: - object - 'null' additionalProperties: description: Any type required: - url title: WebhookConfig AgentConfig-Input: type: object properties: app_id: type: string description: ID of the agent app_version: type: integer description: Version of the agent to use app_type: type: string enum: - agent default: agent description: Always `agent` attempts_per_second: type: number format: double description: >- Rate of outbound call attempts (dials) per second. Every dial counts — initial calls and retries alike. Range: 0.1–500. connection_configs: type: array items: $ref: '#/components/schemas/ConnectionConfig' description: Telephony connection configurations with phone numbers retry_config: $ref: '#/components/schemas/RetryConfig-Input' description: Retry configuration for failed or unanswered calls webhook_config: oneOf: - $ref: '#/components/schemas/WebhookConfig' - type: 'null' description: Optional webhook to receive call completion events required: - app_id - app_version - attempts_per_second - connection_configs - retry_config description: >- Agent configuration including rate limiting, telephony connections, and retry policy. title: AgentConfig-Input CreateCampaignAppConfig: oneOf: - $ref: '#/components/schemas/AgentConfig-Input' description: Agent configuration for the campaign title: CreateCampaignAppConfig DaysOfWeek: type: string enum: - Monday - Tuesday - Wednesday - Thursday - Friday - Saturday - Sunday description: Days of the week for scheduling. title: DaysOfWeek AllowedScheduleConfig: type: object properties: timezone: type: string format: zoneinfo description: IANA timezone, e.g. 'Asia/Kolkata', 'UTC', 'America/New_York' allowed_start_time: type: string description: Start time in HH:MM 24-hour format allowed_end_time: type: string description: End time in HH:MM 24-hour format allowed_days: type: array items: $ref: '#/components/schemas/DaysOfWeek' description: Days of the week when the campaign can run required: - allowed_start_time - allowed_end_time - allowed_days description: Business hours configuration defining when a campaign can make calls. title: AllowedScheduleConfig CreateCampaign: type: object properties: name: type: string description: type: - string - 'null' description: Optional campaign description. Max 150 characters. app_config: $ref: '#/components/schemas/CreateCampaignAppConfig' description: Agent configuration for the campaign start_timestamp: type: string format: date-time description: Campaign start time (ISO 8601) end_timestamp: type: string format: date-time description: Campaign end time (ISO 8601) allowed_schedule: $ref: '#/components/schemas/AllowedScheduleConfig' description: Schedule constraints for when the campaign can run required: - name - app_config - start_timestamp - end_timestamp - allowed_schedule description: >- Request body for creating a new campaign. Ties an agent to a schedule, rate, and retry policy. title: CreateCampaign 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 { "name": "Q1 Payment Reminders", "app_config": { "app_id": "agent-abc123", "app_type": "agent", "app_version": 1, "attempts_per_second": 2, "connection_configs": [ { "connection_id": "conn-xyz", "phone_numbers": [ "+918041234567" ], "weight": 1 } ], "retry_config": { "max_retries": 3, "retry_interval_minutes": 30, "retry_on": { "busy": { "enabled": true }, "no_answer": { "enabled": true }, "short_duration": { "enabled": true, "threshold_seconds": 30 } } }, "webhook_config": { "metadata": { "team": "collections" }, "url": "https://your-server.com/webhook" } }, "start_timestamp": "2026-04-01T09:00:00Z", "end_timestamp": "2026-04-15T18:00:00Z", "allowed_schedule": { "allowed_start_time": "09:00", "allowed_end_time": "18:00", "allowed_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "timezone": "Asia/Kolkata" }, "description": "Outbound reminder calls for Q1 overdue accounts" } ``` **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 Agent campaign with retry and webhook import requests url = "https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns" payload = { "name": "Q1 Payment Reminders", "app_config": { "app_id": "agent-abc123", "app_type": "agent", "app_version": 1, "attempts_per_second": 2, "connection_configs": [ { "connection_id": "conn-xyz", "phone_numbers": ["+918041234567"], "weight": 1 } ], "retry_config": { "max_retries": 3, "retry_interval_minutes": 30, "retry_on": { "busy": { "enabled": True }, "no_answer": { "enabled": True }, "short_duration": { "enabled": True, "threshold_seconds": 30 } } }, "webhook_config": { "metadata": { "team": "collections" }, "url": "https://your-server.com/webhook" } }, "start_timestamp": "2026-04-01T09:00:00Z", "end_timestamp": "2026-04-15T18:00:00Z", "allowed_schedule": { "allowed_start_time": "09:00", "allowed_end_time": "18:00", "allowed_days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"], "timezone": "Asia/Kolkata" }, "description": "Outbound reminder calls for Q1 overdue accounts" } headers = {"Content-Type": "application/json"} response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Agent campaign with retry and webhook const url = 'https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns'; const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"name":"Q1 Payment Reminders","app_config":{"app_id":"agent-abc123","app_type":"agent","app_version":1,"attempts_per_second":2,"connection_configs":[{"connection_id":"conn-xyz","phone_numbers":["+918041234567"],"weight":1}],"retry_config":{"max_retries":3,"retry_interval_minutes":30,"retry_on":{"busy":{"enabled":true},"no_answer":{"enabled":true},"short_duration":{"enabled":true,"threshold_seconds":30}}},"webhook_config":{"metadata":{"team":"collections"},"url":"https://your-server.com/webhook"}},"start_timestamp":"2026-04-01T09:00:00Z","end_timestamp":"2026-04-15T18:00:00Z","allowed_schedule":{"allowed_start_time":"09:00","allowed_end_time":"18:00","allowed_days":["Monday","Tuesday","Wednesday","Thursday","Friday"],"timezone":"Asia/Kolkata"},"description":"Outbound reminder calls for Q1 overdue accounts"}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Agent campaign with retry and webhook 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" payload := strings.NewReader("{\n \"name\": \"Q1 Payment Reminders\",\n \"app_config\": {\n \"app_id\": \"agent-abc123\",\n \"app_type\": \"agent\",\n \"app_version\": 1,\n \"attempts_per_second\": 2,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-xyz\",\n \"phone_numbers\": [\n \"+918041234567\"\n ],\n \"weight\": 1\n }\n ],\n \"retry_config\": {\n \"max_retries\": 3,\n \"retry_interval_minutes\": 30,\n \"retry_on\": {\n \"busy\": {\n \"enabled\": true\n },\n \"no_answer\": {\n \"enabled\": true\n },\n \"short_duration\": {\n \"enabled\": true,\n \"threshold_seconds\": 30\n }\n }\n },\n \"webhook_config\": {\n \"metadata\": {\n \"team\": \"collections\"\n },\n \"url\": \"https://your-server.com/webhook\"\n }\n },\n \"start_timestamp\": \"2026-04-01T09:00:00Z\",\n \"end_timestamp\": \"2026-04-15T18:00:00Z\",\n \"allowed_schedule\": {\n \"allowed_start_time\": \"09:00\",\n \"allowed_end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n },\n \"description\": \"Outbound reminder calls for Q1 overdue accounts\"\n}") req, _ := http.NewRequest("POST", 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 Agent campaign with retry and webhook require 'uri' require 'net/http' url = URI("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Content-Type"] = 'application/json' request.body = "{\n \"name\": \"Q1 Payment Reminders\",\n \"app_config\": {\n \"app_id\": \"agent-abc123\",\n \"app_type\": \"agent\",\n \"app_version\": 1,\n \"attempts_per_second\": 2,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-xyz\",\n \"phone_numbers\": [\n \"+918041234567\"\n ],\n \"weight\": 1\n }\n ],\n \"retry_config\": {\n \"max_retries\": 3,\n \"retry_interval_minutes\": 30,\n \"retry_on\": {\n \"busy\": {\n \"enabled\": true\n },\n \"no_answer\": {\n \"enabled\": true\n },\n \"short_duration\": {\n \"enabled\": true,\n \"threshold_seconds\": 30\n }\n }\n },\n \"webhook_config\": {\n \"metadata\": {\n \"team\": \"collections\"\n },\n \"url\": \"https://your-server.com/webhook\"\n }\n },\n \"start_timestamp\": \"2026-04-01T09:00:00Z\",\n \"end_timestamp\": \"2026-04-15T18:00:00Z\",\n \"allowed_schedule\": {\n \"allowed_start_time\": \"09:00\",\n \"allowed_end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n },\n \"description\": \"Outbound reminder calls for Q1 overdue accounts\"\n}" response = http.request(request) puts response.read_body ``` ```java Agent campaign with retry and webhook import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns") .header("Content-Type", "application/json") .body("{\n \"name\": \"Q1 Payment Reminders\",\n \"app_config\": {\n \"app_id\": \"agent-abc123\",\n \"app_type\": \"agent\",\n \"app_version\": 1,\n \"attempts_per_second\": 2,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-xyz\",\n \"phone_numbers\": [\n \"+918041234567\"\n ],\n \"weight\": 1\n }\n ],\n \"retry_config\": {\n \"max_retries\": 3,\n \"retry_interval_minutes\": 30,\n \"retry_on\": {\n \"busy\": {\n \"enabled\": true\n },\n \"no_answer\": {\n \"enabled\": true\n },\n \"short_duration\": {\n \"enabled\": true,\n \"threshold_seconds\": 30\n }\n }\n },\n \"webhook_config\": {\n \"metadata\": {\n \"team\": \"collections\"\n },\n \"url\": \"https://your-server.com/webhook\"\n }\n },\n \"start_timestamp\": \"2026-04-01T09:00:00Z\",\n \"end_timestamp\": \"2026-04-15T18:00:00Z\",\n \"allowed_schedule\": {\n \"allowed_start_time\": \"09:00\",\n \"allowed_end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n },\n \"description\": \"Outbound reminder calls for Q1 overdue accounts\"\n}") .asString(); ``` ```php Agent campaign with retry and webhook request('POST', 'https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns', [ 'body' => '{ "name": "Q1 Payment Reminders", "app_config": { "app_id": "agent-abc123", "app_type": "agent", "app_version": 1, "attempts_per_second": 2, "connection_configs": [ { "connection_id": "conn-xyz", "phone_numbers": [ "+918041234567" ], "weight": 1 } ], "retry_config": { "max_retries": 3, "retry_interval_minutes": 30, "retry_on": { "busy": { "enabled": true }, "no_answer": { "enabled": true }, "short_duration": { "enabled": true, "threshold_seconds": 30 } } }, "webhook_config": { "metadata": { "team": "collections" }, "url": "https://your-server.com/webhook" } }, "start_timestamp": "2026-04-01T09:00:00Z", "end_timestamp": "2026-04-15T18:00:00Z", "allowed_schedule": { "allowed_start_time": "09:00", "allowed_end_time": "18:00", "allowed_days": [ "Monday", "Tuesday", "Wednesday", "Thursday", "Friday" ], "timezone": "Asia/Kolkata" }, "description": "Outbound reminder calls for Q1 overdue accounts" }', 'headers' => [ 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Agent campaign with retry and webhook using RestSharp; var client = new RestClient("https://apps.sarvam.ai/api/scheduling/v1/orgs/org_id/workspaces/workspace_id/campaigns"); var request = new RestRequest(Method.POST); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"name\": \"Q1 Payment Reminders\",\n \"app_config\": {\n \"app_id\": \"agent-abc123\",\n \"app_type\": \"agent\",\n \"app_version\": 1,\n \"attempts_per_second\": 2,\n \"connection_configs\": [\n {\n \"connection_id\": \"conn-xyz\",\n \"phone_numbers\": [\n \"+918041234567\"\n ],\n \"weight\": 1\n }\n ],\n \"retry_config\": {\n \"max_retries\": 3,\n \"retry_interval_minutes\": 30,\n \"retry_on\": {\n \"busy\": {\n \"enabled\": true\n },\n \"no_answer\": {\n \"enabled\": true\n },\n \"short_duration\": {\n \"enabled\": true,\n \"threshold_seconds\": 30\n }\n }\n },\n \"webhook_config\": {\n \"metadata\": {\n \"team\": \"collections\"\n },\n \"url\": \"https://your-server.com/webhook\"\n }\n },\n \"start_timestamp\": \"2026-04-01T09:00:00Z\",\n \"end_timestamp\": \"2026-04-15T18:00:00Z\",\n \"allowed_schedule\": {\n \"allowed_start_time\": \"09:00\",\n \"allowed_end_time\": \"18:00\",\n \"allowed_days\": [\n \"Monday\",\n \"Tuesday\",\n \"Wednesday\",\n \"Thursday\",\n \"Friday\"\n ],\n \"timezone\": \"Asia/Kolkata\"\n },\n \"description\": \"Outbound reminder calls for Q1 overdue accounts\"\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Agent campaign with retry and webhook import Foundation let headers = ["Content-Type": "application/json"] let parameters = [ "name": "Q1 Payment Reminders", "app_config": [ "app_id": "agent-abc123", "app_type": "agent", "app_version": 1, "attempts_per_second": 2, "connection_configs": [ [ "connection_id": "conn-xyz", "phone_numbers": ["+918041234567"], "weight": 1 ] ], "retry_config": [ "max_retries": 3, "retry_interval_minutes": 30, "retry_on": [ "busy": ["enabled": true], "no_answer": ["enabled": true], "short_duration": [ "enabled": true, "threshold_seconds": 30 ] ] ], "webhook_config": [ "metadata": ["team": "collections"], "url": "https://your-server.com/webhook" ] ], "start_timestamp": "2026-04-01T09:00:00Z", "end_timestamp": "2026-04-15T18:00:00Z", "allowed_schedule": [ "allowed_start_time": "09:00", "allowed_end_time": "18:00", "allowed_days": ["Monday", "Tuesday", "Wednesday", "Thursday", "Friday"], "timezone": "Asia/Kolkata" ], "description": "Outbound reminder calls for Q1 overdue accounts" ] 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")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" 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() ```