GEgetsales
agent_scenarios

Update agent scenario

Edit a scenario: by sid (a row of the team's), or by platform key (the first edit bears the team's row). The steps (the list replaced whole: switch one off, reorder, delete, add, reword a step's instructions, its when, its parameters), the instructions over them (context), the level with its conditions (autopilot, copilot, conditional, off); a team's own scenario also its title and trigger. A locked step stays on as it is; a parameter outside its dictionary is a 422.

Contract:

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

Request

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

Path parameters

sidstring required

ub_sc_ sid or key: interested, meeting_request, info_request, referral, not_now, out_of_office, auto_reply, wrong_person, reschedule_request, cancel_request, other_low_signal, not_interested, objection, do_not_contact, followup_no_reply, signal_followup.

Request body

agent_sidstring

The AI SDR whose scenario it is (ub_ag_…); with a platform key, which agent's version. Left out, the team's default agent.

titlestring

The team's own scenario only: a platform scenario's name is the platform's (422).

triggerstring

The team's own scenario only (422 on a platform scenario).

contextstring nullable

The instructions over the playbook; null clears them.

level'autopilot' | 'copilot' | 'conditional' | 'off'

The level: autopilot, copilot, conditional (with conditions) or off. On a platform key the first edit bears the team's row; reset_agent_scenario puts the seed's level back.

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.