Create deployment

View as Markdown

Create a new deployment that connects an agent to a phone number for inbound calls.

The deployment is created in active status and immediately begins accepting calls. Optionally configure an inbound_config schedule to restrict calls to specific hours and days.

Path parameters

org_idstringRequired
workspace_idstringRequired

Request

This endpoint expects an object.
namestringRequiredformat: "^[\w\- ]{1,50}$"<=50 characters
Deployment name. Alphanumeric, hyphens, underscores and spaces allowed. Max 50 characters.
app_idstringRequired
ID of the agent
app_versionintegerRequired
Version of the agent to deploy
connection_configslist of objectsRequired
Telephony connection configurations with phone numbers
descriptionstring or nullOptional<=150 characters
Optional deployment description. Max 150 characters.
inbound_configobject or nullOptional
Optional inbound call schedule configuration

Response

Successful Response
deployment_idstring
Unique identifier for the deployment
app_idstring
ID of the agent
app_versioninteger
Version of the agent
connection_configslist of objects
Telephony connection configurations
channel_directionenum

Direction of calls (inbound, outbound, or both)

created_bystring
User who created this deployment
created_atdatetime

Timestamp when created (ISO 8601)

updated_atdatetime

Timestamp when last updated (ISO 8601)

namestring or null
Name of the deployment
statusenum or null
Current status of the deployment
descriptionstring or null
Optional description
inbound_configobject or null
Inbound call schedule configuration
updated_bystring or null
User who last updated this deployment

Errors

422
Unprocessable Entity Error