Search
K
Agents API

MergeBranchBody

object
* Additional properties are NOT allowed.
deploymentMessagestring

Default:

conflictResolutionsarray[object]
* Additional properties are NOT allowed.
Show Child Parameters
Example

MutationDeploymentResponse

object

The resulting deployment from a promote / rollback / publish action,
plus any test runs it triggered.

deploymentobjectrequired

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

Show Child Parameters
testRunIdsarray[string]

IDs of test runs triggered by this deployment action

Example

PhoneNumberResponse

object

A phone number owned by the project, plus the connector it routes incoming calls to.

numberstringrequired

Phone number in E.164 format

projectIdstringrequired

Project this number belongs to

accountIdstringrequired

Account this number belongs to

clientEnvstringrequired

Client environment (sandbox, pre-release, live)

connectorIdstring

Connector this number is routed to

Example

PromoteDeploymentBody

object

Metadata attached to a promote action: an optional message and an
explicit target environment override.

deploymentMessagestring

Message describing this promotion

Default:

targetEnvironmentstring

Target environment to promote to. If omitted, promotes to the next environment in sequence (sandbox->pre-release->live).

Example

PublishDeploymentBody

object

Metadata attached to a publish action, with an optional target environment.

deploymentMessagestring

Message describing this publish

Default:

environmentstring

Environment to publish to (defaults to sandbox)

Example