Search
K
Agents API

DeletePhoneNumberResponse

object

The phone number that was released.

deletedstringrequired

The deleted phone number

Example

DeletePhoneNumbersBody

object

Phone numbers to release in a single call.

Releases are processed independently; see the response for per-number results.

phoneNumbersarray[string]required

List of phone numbers to delete

>= 1 items

Example

DeletePhoneNumbersResponse

object

Per-number results of a batch release — phone numbers that were
successfully released, plus any that couldn’t be and why.

deletedarray[string]required

Successfully deleted phone numbers

errorsarray[object]

An error encountered while deleting a phone number in a batch.

Show Child Parameters
Example

DeploymentResponse

object

A deployment of an agent version to a specific environment, plus
who created it and when.

idstringrequired

Unique deployment identifier

accountIdstringrequired

Account this deployment belongs to

agentIdstringrequired

Agent (project) this deployment belongs to

environmentstringrequired

Environment (sandbox, pre-release, live)

artifactVersionstringrequired

Artifact version reference

versionstringrequired

Version hash linking deployments across environments

createdBystringrequired

Email of user who created the deployment

createdAtstringrequired

ISO 8601 timestamp of when the deployment was created

metadataobject

Deployment metadata (e.g. deployment_message)

Example

DuplicateAgentBody

object
* Additional properties are NOT allowed.
newAgentIdstring

Match pattern:^[a-zA-Z0-9-]+$

newAgentNamestringrequired

>= 1 characters<= 100 characters

Example