Skip to main content
Take Agent Off Air
The reverse of make live, and gated the same way, because it is just as visible to callers: the agent stops answering and releases the numbers it was answering on. Nothing is deleted. Every version survives, and making one live again brings the agent straight back.

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.

Response

The version the agent was taken off. It still exists — nothing is deleted.

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.