Take an agent off air
Stop an agent answering, without deleting it.
Authorizations
Your API key as a Bearer token, e.g. Authorization: Bearer vk_….
Path Parameters
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.
This version's number — what you pass in /versions/{n}.
This version's uuid. Published because POST /v1/calls pins a call with agent_version_id, which takes a uuid rather than a number.
True once frozen. Configuration can never be edited again; label and notes still can.
True if this is the version answering calls right now.
This version's edit counter. Send it as If-Match to make a write conditional.
When this version was created (UTC, ISO 8601).
Short name for this version.
Longer free text about this version.
Which version this one was branched from, by NUMBER — null for the agent's first.
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.
The phone number this version will answer on once it is made live. Inert until then.
The WhatsApp number this version will answer on once it is made live. Inert until then.
When it was frozen. null while it is still a draft.