PATCH
/
v1
/
orgs
/
{org_id}
/
workspaces
/
{workspace_id}
/
deployments
/
{deployment_id}
Update Deployment
curl --request PATCH \
  --url https://apps.sarvam.ai/api/app-authoring/v1/orgs/{org_id}/workspaces/{workspace_id}/deployments/{deployment_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "name": "Customer Support Line v2",
  "app_version": 4,
  "inbound_config": {
    "start_time": "08:00",
    "end_time": "20:00",
    "allowed_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday",
      "Saturday"
    ],
    "timezone": "Asia/Kolkata"
  }
}
'
{
  "name": "Customer Support Line",
  "deployment_id": "dep-a1b2c3d4",
  "status": "active",
  "description": "Main support deployment for EN and HI",
  "app_id": "my-support-agent",
  "app_version": 3,
  "connection_configs": [
    {
      "connection_id": "conn-exotel-001",
      "phone_numbers": [
        "+918047168000"
      ]
    }
  ],
  "channel_direction": "inbound",
  "inbound_config": {
    "start_time": "09:00",
    "end_time": "18:00",
    "allowed_days": [
      "Monday",
      "Tuesday",
      "Wednesday",
      "Thursday",
      "Friday"
    ],
    "timezone": "Asia/Kolkata"
  },
  "created_by": "user@company.com",
  "created_at": "2026-03-01T10:00:00Z",
  "updated_by": "user@company.com",
  "updated_at": "2026-03-15T14:30:00Z"
}

​
Overview

Update a deployment’s configuration. Common use cases:
  • Roll out a new agent version — set app_version to the latest committed version
  • Change the schedule — update inbound_config to expand or restrict calling hours
  • Update phone numbers — change connection_configs to add or remove lines
Only include the fields you want to change. Fields set to null or omitted are left unchanged.
Consider pausing the deployment before making changes to avoid callers hitting a partially-updated configuration, then resume once done.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
org_id
string
required
​
workspace_id
string
required
​
deployment_id
string
required

Body

application/json

Request body for updating a deployment's configuration.

​
name
string | null

Updated deployment name

Maximum string length: 50
Pattern: ^[\w\- ]{1,50}$
​
description
string | null

Updated deployment description

Maximum string length: 150
​
app_version
integer | null

Updated agent version

​
connection_configs
ConnectionConfig · object[] | null

Updated telephony connections

​
inbound_config
InboundConfig · object

Updated inbound call schedule

Example:
{
  "start_time": "09:00",
  "end_time": "18:00",
  "allowed_days": [
    "Monday",
    "Tuesday",
    "Wednesday",
    "Thursday",
    "Friday"
  ],
  "timezone": "Asia/Kolkata"
}

Response

Successful Response

Full deployment details including agent configuration, inbound settings, and status.

​
deployment_id
string
required

Unique identifier for the deployment

Example:

"dep-a1b2c3d4"

​
app_id
string
required

ID of the agent

Example:

"my-support-agent"

​
app_version
integer
required

Version of the agent

Example:

3

​
connection_configs
ConnectionConfig · object[]
required

Telephony connection configurations

​
channel_direction
enum<string>
required

Direction of calls (inbound, outbound, or both)

Available options:
inbound,
outbound,
inbound_outbound
​
created_by
string
required

User who created this deployment

Example:

"user@company.com"

​
created_at
string<date-time>
required

Timestamp when created (ISO 8601)

Example:

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

​
updated_at
string<date-time>
required

Timestamp when last updated (ISO 8601)

Example:

"2026-03-15T14:30:00Z"

​
name
string | null

Name of the deployment

​
status
enum<string> | null

Current status of the deployment

Available options:
active,
paused
​
description
string | null

Optional description

​
inbound_config
InboundConfig · object

Inbound call schedule configuration

Example:
{
  "start_time": "09:00",
  "end_time": "18:00",
  "allowed_days": [
    "Monday",
    "Tuesday",
    "Wednesday",
    "Thursday",
    "Friday"
  ],
  "timezone": "Asia/Kolkata"
}
​
updated_by
string | null

User who last updated this deployment