GEgetsales
agent_plans

Update agent plan

The human verb on a plan, four intents in one call: approve it (state active), stop it (state canceled), rewrite its steps (texts included), or end its counting wait now (end_wait). The agent's own token is 403 forbidden (human_verb_only). A step edit replaces only what has not run; done, skipped or failed steps are locked (422). 409 plan_not_editable once completed, superseded or canceled; 409 plan_rewrite_in_flight while steer_agent_plan's rewrite moves.

Contract:

  • MCP tool update_agent_plan, registry package mcp.unibox/agent_plans, mount unibox.agent.
  • Operation update, response envelope update.
  • Flags: none.
patch/api/agent-plans/{sid}

Request

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

Path parameters

sidstring required

Agent plan sid (ub_pl_…).

Request body

state'active' | 'canceled'

active approves a proposed plan (stamps approved_by_user_sid, releases the parked steps and arms the first one); canceled stops it and hands the thread back. Nothing else is accepted: completed and superseded are system-owned and rejected.

end_waitboolean

true: the wait the active plan is counting down ends now, so what follows goes at once, through the follow-up caps a wait that ran out meets. 409 no_wait_to_end when the next step is not a wait counting down. Runs after the other fields.

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.