GEgetsales
agent_scenarios

Create agent scenario

Add a scenario of the team's own: when the trigger text matches an incoming reply the agent follows this scenario (its own steps when it has them, else the classified scenario's playbook with the context over it). Takes effect from the next classify run; at most 20 of the team's own that are not Off. Born autopilot unless level says otherwise. A platform scenario is never created: edit it by key with update_agent_scenario.

Contract:

  • MCP tool create_agent_scenario, registry package mcp.unibox/agent_scenarios, mount unibox.agent.
  • Operation create, response envelope create.
  • Flags: none.
post/api/agent-scenarios

Request

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

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 required

The scenario's name, 1..255 chars, the natural key inside the team.

triggerstring required

When the scenario applies, in plain language, written for an LLM to match against one inbound reply.

contextstring nullable

The instructions over the playbook, any length; the compaction writes the copy the model reads after the save.

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

Default autopilot. off drafts no reply (the other steps still run; a task step hands the thread over). The 21st own scenario is a 429 limit_exceeded.

Response

create success envelope.

successtrue required
operation'create' required
already_existsboolean required

Changes

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