Agents API

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

ReassignPhoneNumberBody

object

Target connector for reassigning a phone number.

connectorIdstringrequired

Target connector ID to reassign the phone number to

Example

RollbackDeploymentBody

object

Metadata attached to a rollback action.

deploymentMessagestring

Message describing this rollback

Default:

Example

UpdateAgentRulesBody

object
* Additional properties are NOT allowed.
behaviorstringrequired

>= 1 characters

Example