GEgetsales
agents

Update agent

Change an AI SDR by sid: state, mode, name, is_default (true makes it the team's default), the Brief, knowledge, settings, the Rules, the hosts, setup, llm_config, golden_set (the Words). Each value replaces the stored one whole: read the agent first and send it back; the compaction's copies and the voice are read-only. The Rules, the hosts and the voice have doors of their own (update_agent_rules, update_agent_hosts, update_agent_voice); per-thread autonomy is update_conversation.

Contract:

  • MCP tool update_agent, registry package mcp.unibox/agents, mount unibox.agent.
  • Operation update, response envelope update.
  • Flags: dangerous: the MCP layer gates it behind a preview/commit token, and the effect cannot be undone through this API.
patch/api/agents/{sid}

Request

  • Base URL
    https://beta.getsales.io/unibox/v1
  • Auth
    HTTP bearer and API key in header Team-SID

Path parameters

sidstring required

The agent to change (ub_ag_…).

Request body

state'on' | 'off'

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.

mode'copilot' | 'autopilot' | 'off'

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

namestring

Display name, 1..255 chars.

is_defaulttrue

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.

Response

update success envelope.

successtrue required
operation'update' required
updated_fieldsstring[] required
previous_valuesobject required
kept_fieldsstring[]

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

Changes

No recorded changes to this operation across all 1 revision of this API.