Skip to main content
PUT

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Headers

Idempotency-Key
string

Optional. Send a unique value to retry safely: a retry with the same key within 10 minutes returns the first response instead of applying the change again. Reusing a key with a different body is refused (422 IdempotencyKeyReused); a retry while the first request is still running gets 409 IdempotencyKeyInProgress.

Maximum string length: 255
Example:

"b3f1c2d4-save-1"

Path Parameters

voiceAgentId
string<uuid>
required

ID of the voice agent.

Example:

"d949f13f-40d2-4e48-ac86-b66633070603"

environmentId
string<uuid>
required

ID of the environment (from the list of environments).

Example:

"5b9d1e7f-2c3a-4f8b-8d16-7e9f0a1b2c3d"

Body

application/json
versionId
string<uuid>
required

The version to run in this environment.

Example:

"a1b2c3d4-5e6f-4a7b-8c9d-0e1f2a3b4c5d"

expectedVersionId
string<uuid> | null

Optional. The version you saw the environment running (publishedVersionId), null if none. If it differs now, nothing changes (409).

Example:

"d4c3b2a1-6f5e-4b7a-9d8c-5d4c3b2a1f0e"

expectedDeployment
object[]

Optional, for prod. The A/B split you saw. If it differs now, nothing changes (409).

Minimum array length: 1

Response

Deployed. Returns the environment.

success
boolean
Example:

true

message
string
Example:

"success"

data
object