PUT
Update Deployment Status

Overview

Pause or resume a deployment. When paused, inbound calls to the deployment’s phone numbers are not answered. Available actions:
Pause a deployment before updating its agent version or connection config. This prevents callers from hitting a partially-updated configuration.

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 changing a deployment's status.

action
enum<string>
required

Action to perform: pause or resume

Available options:
pause,
resume

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

Inbound call schedule configuration

Example:
updated_by
string | null

User who last updated this deployment