Skip to main content
PATCH
Update agent

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

The agent to change (ub_ag_…).

Required string length: 18
Pattern: ^ub_ag_

Body

application/json

Request body of update_agent.

state
enum<string>

on starts planning and acting, off stops it (classification keeps running either way). setup_required is system-owned and rejected. Going to on the first time needs the Brief complete (no slot left, every section answered): else a 422 naming what is left.

Available options:
on,
off
mode
enum<string>

The FALLBACK autonomy mode only. A per-thread override or an owning automation still wins over it.

Available options:
copilot,
autopilot,
off
name
string

Display name, 1..255 chars.

Required string length: 1 - 255
is_default
enum<boolean>

true makes this agent the team's default; the previous default loses the flag in the same transaction, and the threads that follow the default re-project. false is refused on the default (the team always has one): make another agent the default instead.

Available options:
true
knowledge
object

REPLACES the stored knowledge pack wholesale (no deep merge): read it first and send every key you keep. Its old prose keys (offer, icp, tone_of_voice, general_context) are refused: the Brief holds them.

brief
object

The Brief, replaced whole: read it first and send the whole text back with the change; the compaction's copies are read-only (422).

setup
object

The advised steps to go live the team skips, replaced whole.

settings
object

REPLACES the stored caps wholesale, same rule as knowledge. Changes apply from the next gate evaluation; plans already running are not re-edited.

rules
object

The Rules, replaced whole (a key left out takes its corpus default); update_agent_rules changes one field at a time.

hosts
object[]

The hosts, replaced whole, at most 20; update_agent_hosts is the same door on its own.

Maximum array length: 20
goal
object | null

The goal, replaced whole: its kind (call, signup, webinar or custom; decides the stage after a yes) and its words ("a 20-minute call with Peter"); null puts the call with no words back. The link stays the sender host's: set it with update_agent_hosts.

llm_config
object | null

REPLACES the model routing wholesale; null clears it back to platform defaults.

golden_set
object

The Words the agent never writes, each with what to say instead; the voice is formed from the replies and never sent here (422): a line of it is set with update_agent_voice.

Response

update success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
update
item
object
required
updated_fields
string[]
required
previous_values
object
required
meta
object
required
kept_fields
string[]

The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed.