Skip to main content
Make Version Live
This is the moment real callers reach the new configuration. Everything before it — creating, editing, publishing — is invisible to them.
Applies the version’s numbers at the same time: the phone and WhatsApp numbers it recorded start ringing it now. A number recorded on a version routes nothing until this call.

Rolling back

Make an older published version live again. Calls in progress finish on the version they started on — a version is resolved once, when the call begins.

When it is refused

Authorizations

Authorization
string
header
required

Your API key as a Bearer token, e.g. Authorization: Bearer vk_….

Path Parameters

agent_id
string
required

The agent's id, as GET /v1/agents returns it.

version_id
string
required

A version number (0, 1, 3) or a version uuid — both resolve. Prefer the number: it is the version's identity to you, it is what every version read returns, and it needs no lookup first.

Response

The version now answering calls.

One version in an agent's history.

Versions are identified by NUMBER: it is what every version read returns and what ?version= and /versions/{n} take.

version
integer
required

This version's number — what you pass in /versions/{n}.

version_id
string
required

This version's uuid. Published because POST /v1/calls pins a call with agent_version_id, which takes a uuid rather than a number.

is_published
boolean
required

True once frozen. Configuration can never be edited again; label and notes still can.

is_live
boolean
required

True if this is the version answering calls right now.

document_revision
integer
required

This version's edit counter. Send it as If-Match to make a write conditional.

created_at
string<date-time>
required

When this version was created (UTC, ISO 8601).

label
string | null

Short name for this version.

notes
string | null

Longer free text about this version.

base_version
integer | null

Which version this one was branched from, by NUMBER — null for the agent's first.

blocked_reasons
string[]

Why this version cannot be made live, if it cannot — e.g. it pins a retired model. Check it before offering a deploy button, so the button never fails on click.

inbound_phone
string | null

The phone number this version will answer on once it is made live. Inert until then.

inbound_whatsapp
string | null

The WhatsApp number this version will answer on once it is made live. Inert until then.

published_at
string<date-time> | null

When it was frozen. null while it is still a draft.