> ## Documentation Index > Fetch the complete documentation index at: https://docs.getsales.io/llms.txt > Use this file to discover all available pages before exploring further. # 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. ## OpenAPI ````yaml /api-reference/unibox/openapi.yaml patch /api/agent-scenarios/{sid} openapi: 3.0.3 info: title: 'GetSales public contract: gs.service.unibox' description: >- The team inbox and the AI SDR: every LinkedIn and email thread in one place (conversations, messages, the timeline events), the manual tasks a thread spawns, the sender profiles the team speaks through with their LinkedIn account and mailboxes, and the one agent per team with its scenarios, plans and runs. GENERATED. This document is projected from the Zod MCP tool registry in `product/mcp/gs.mcp` (one tool per public endpoint, 1:1). Do not edit it by hand; edit the tool definition and regenerate with `pnpm openapi:public`. Surface: the public `/api` contract of `gs.service.unibox`, 125 operations. This is the only OpenAPI document the platform publishes. Internal (`/internal`) and health endpoints are deliberately absent: they are not part of any contract, they can change without notice, and the service source is their only description. Conventions: - Auth is a bearer JWT, optionally narrowed by the `Team-SID` header. - Every success body is an MCP envelope: `success: true` plus one typed `operation` shape (`search`, `get`, `create`, `update`, `delete`, `metrics`, `group_by`, `action`), and a `meta` block with `trace_id` for support. - Every failure is the same `McpError` envelope with a code from a fixed 16-code taxonomy, so a client maps errors once. - Lists page with `page_size` (0 to 500, default 50) plus an opaque forward `cursor`; `page_size: 0` returns counts only. - On `GET` and `DELETE`, object-valued query parameters (`filter`, `sort`) travel as JSON text and array-valued ones repeat as `name[]=value`. - The MCP-only `_meta` field (usage analytics) never reaches the backend and is not part of this contract. version: '1.0' contact: name: GetSales url: https://getsales.io email: support@getsales.io license: name: Proprietary url: https://getsales.io/terms servers: - url: https://beta.getsales.io/unibox/v1 description: >- Production (the gateway path on the beta ring; the origin is provisioned per DEPLOY_MAP.md) security: - BearerJwt: [] TeamSid: [] tags: - name: agent_answers description: >- Registry package `mcp.unibox/agent_answers`, served on MCP mount `unibox.knowledge`. - name: agent_conversation_uploads description: >- Registry package `mcp.unibox/agent_conversation_uploads`, served on MCP mount `unibox.agent-memory`. - name: agent_examples description: >- Registry package `mcp.unibox/agent_examples`, served on MCP mount `unibox.agent-memory`. - name: agent_hints description: >- Registry package `mcp.unibox/agent_hints`, served on MCP mount `unibox.agent-memory`. - name: agent_plans description: >- Registry package `mcp.unibox/agent_plans`, served on MCP mount `unibox.agent`. - name: agent_runs description: >- Registry package `mcp.unibox/agent_runs`, served on MCP mount `unibox.agent-memory`. - name: agent_scenarios description: >- Registry package `mcp.unibox/agent_scenarios`, served on MCP mount `unibox.agent`. - name: agent_source_parses description: >- Registry package `mcp.unibox/agent_source_parses`, served on MCP mount `unibox.knowledge`. - name: agent_sources description: >- Registry package `mcp.unibox/agent_sources`, served on MCP mount `unibox.knowledge`. - name: agent_tests description: >- Registry package `mcp.unibox/agent_tests`, served on MCP mount `unibox.agent-memory`. - name: agents description: >- Registry package `mcp.unibox/agents`, served on MCP mount `unibox.website`. - name: conversation_events description: >- Registry package `mcp.unibox/conversation_events`, served on MCP mount `unibox.inbox`. - name: conversations description: >- Registry package `mcp.unibox/conversations`, served on MCP mount `unibox.inbox`. - name: messages description: >- Registry package `mcp.unibox/messages`, served on MCP mount `unibox.inbox`. - name: sender_profiles description: >- Registry package `mcp.unibox/sender_profiles`, served on MCP mount `unibox.sender-profiles`. - name: tasks description: Registry package `mcp.unibox/tasks`, served on MCP mount `unibox.inbox`. - name: timeline description: >- Registry package `mcp.unibox/timeline`, served on MCP mount `unibox.inbox`. paths: /api/agent-scenarios/{sid}: patch: tags: - agent_scenarios summary: Update agent scenario description: >- 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. operationId: update_agent_scenario parameters: - name: sid in: path required: true description: >- 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. schema: type: string minLength: 1 maxLength: 64 description: >- 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. requestBody: required: false content: application/json: schema: $ref: '#/components/schemas/UpdateAgentScenarioRequest' responses: '200': description: '`update` success envelope.' content: application/json: schema: $ref: '#/components/schemas/UpdateAgentScenarioResponse' 4XX: $ref: '#/components/responses/McpClientError' 5XX: $ref: '#/components/responses/McpServerError' components: schemas: UpdateAgentScenarioRequest: type: object description: Request body of `update_agent_scenario`. properties: agent_sid: type: string minLength: 18 maxLength: 18 pattern: ^ub_ag_ description: >- The AI SDR whose scenario it is (ub_ag_…); with a platform key, which agent's version. Left out, the team's default agent. title: type: string minLength: 1 maxLength: 255 description: >- The team's own scenario only: a platform scenario's name is the platform's (422). trigger: type: string minLength: 1 maxLength: 2048 description: The team's own scenario only (422 on a platform scenario). context: type: string nullable: true maxLength: 32768 description: The instructions over the playbook; null clears them. steps: type: array nullable: true items: type: object properties: id: type: string minLength: 1 maxLength: 32 kind: type: string enum: - react - move_stage - like_post - send_message - wait_for_reply - wait_until - create_task - find_people - reach_objective - use_playbook - resume_orchestration - stoplist_person enabled: type: boolean locked: type: boolean when: type: string nullable: true maxLength: 512 instructions: type: string nullable: true maxLength: 2048 params: type: object additionalProperties: {} required: - id - kind maxItems: 16 description: >- FULL-REPLACE of the step list: on a platform scenario the fork (null drops it, the seed applies again; a locked step stays on, as it is); on the team's own scenario its steps. level: type: string enum: - autopilot - copilot - conditional - 'off' description: >- 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. conditions: type: array nullable: true items: type: object properties: kind: type: string enum: - lead - no_answer description: Default lead. when: type: string nullable: true minLength: 3 maxLength: 255 description: Required on a lead condition; ignored on the built-in one. then: type: string enum: - copilot - 'off' description: Default copilot. maxItems: 6 description: >- FULL-REPLACE of a Conditional level's conditions, in order (at most 6); null clears them. Read on every reply: the first that holds decides, Autopilot otherwise. UpdateAgentScenarioResponse: type: object properties: success: type: boolean enum: - true operation: type: string enum: - update item: type: object properties: sid: type: string nullable: true description: >- Agent scenario sid (ub_sc_…); null on a platform scenario the team never touched (no row yet: address it by scenario_key). team_sid: type: string description: Owning team (ts_tm_…, external - gs.service.id). agent_sid: type: string nullable: true description: >- The AI SDR the row belongs to (ub_ag_…; block 10, 2026-10-30): its versions of the platform scenarios and its own rows. A seed item names the agent it was read for. scenario_key: type: string nullable: true description: A platform scenario's key; null = the agent's own scenario. title: type: string nullable: true description: >- The team's own scenario: its name, 1..255 chars, the natural key inside the team. A platform scenario: null (the platform's title is in `seed`). trigger: type: string nullable: true description: >- The team's own scenario: the "when this applies" text, 1..2048 chars, read by the classify verbatim against the incoming reply. A platform scenario: null (the classify key decides it). context: type: string nullable: true description: >- The instructions over the playbook, a person's text of any length (max 32768). context_compact: type: string nullable: true description: >- [ro] The copy the model reads, written by the compaction after a save that moved the context; null until it lands. steps: type: array nullable: true items: type: object properties: id: type: string minLength: 1 maxLength: 32 description: >- Stable inside the playbook (react, stage, reply, wait, followup, last_wait, task on the platform seeds); minted for an added step. kind: type: string enum: - react - move_stage - like_post - send_message - wait_for_reply - wait_until - create_task - find_people - reach_objective - use_playbook - resume_orchestration - stoplist_person enabled: type: boolean description: 'Off: never planned under this scenario.' locked: type: boolean description: >- Platform only: the step cannot be switched off, moved or removed (the stoplist step of do_not_contact). when: type: string nullable: true maxLength: 512 description: >- "Plan it when ...": the condition the planning turn judges; null = always. instructions: type: string nullable: true maxLength: 2048 description: >- What the step must do or say, the text the model reads; the product copy a team reads IS the prompt text. params: type: object additionalProperties: {} description: >- The kind's product parameters, each a value of its dictionary (see above). required: - id - kind - enabled - locked - when - instructions - params description: >- A platform row: the team's fork of the seed's step list, null = the seed's list applies. A team's own row: its own steps, null = the classified scenario's playbook applies with the context over it. steps_base_version: type: integer nullable: true description: >- A platform row with a fork: the seed version the fork was taken from (compare with seed.version: "the default changed"). level: type: string nullable: true enum: - autopilot - copilot - conditional - 'off' description: >- The row's level (block AC4): autopilot, copilot, conditional or off; null on a platform row that keeps the seed's (playbook.level says which stands). A team's own row is born autopilot. conditions: type: array nullable: true items: type: object properties: kind: type: string enum: - lead - no_answer description: >- lead: the team's words, judged by the classifier; no_answer: the built-in one, a question Knowledge has no answer for, read by unibox from the turn's missing-answer signal. when: type: string nullable: true maxLength: 255 description: >- A lead condition's words completing "when the lead ..." ("mentions a contract or a security review"), 3..255 chars; null on the built-in one. then: type: string enum: - copilot - 'off' description: >- What the reply gets when the condition holds: copilot (drafted for a person's OK) or off (nothing drafted). required: - kind - when - then description: >- The row's conditions when its level is conditional, in order (at most 6); null otherwise. created_by: type: object nullable: true properties: actor_type: type: string enum: - user - support - api_key - system - agent actor_sid: type: string nullable: true team_sid: type: string actor_name: type: string nullable: true description: >- The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job. oauth_client_sid: type: string nullable: true description: The acting OAuth client (id_oc_*); null off the OAuth path. reason: type: string nullable: true description: >- Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise. permissions: type: object additionalProperties: {} description: >- Internal audit context: the grant set the actor held at write time. Not a contract. cluster_id: type: integer nullable: true description: 'Internal audit context: the cluster that served the write.' trace_id: type: string nullable: true description: >- Internal audit context: the trace id of the request that wrote the row. required: - actor_type - actor_sid - team_sid - permissions description: >- Actor that wrote the row; null on a platform scenario with no row. match_count: type: integer minimum: 0 description: >- A team's own scenario: lifetime matches, bumped asynchronously after each classify run. last_matched_at: type: string nullable: true description: ISO 8601 UTC of the most recent match; null = never matched. deleted_by: type: object nullable: true properties: actor_type: type: string enum: - user - support - api_key - system - agent actor_sid: type: string nullable: true team_sid: type: string actor_name: type: string nullable: true description: >- The OAuth client that acted ("Claude", "n8n"); null for a user, an API key or a system job. oauth_client_sid: type: string nullable: true description: The acting OAuth client (id_oc_*); null off the OAuth path. reason: type: string nullable: true description: >- Why a system actor wrote the row (snapshot_capture_job, ...); null otherwise. permissions: type: object additionalProperties: {} description: >- Internal audit context: the grant set the actor held at write time. Not a contract. cluster_id: type: integer nullable: true description: 'Internal audit context: the cluster that served the write.' trace_id: type: string nullable: true description: >- Internal audit context: the trace id of the request that wrote the row. required: - actor_type - actor_sid - team_sid - permissions created_at: type: string nullable: true updated_at: type: string nullable: true deleted_at: type: string nullable: true source: type: string enum: - platform - edited - custom description: >- platform = the seed as it ships; edited = the team's version of a platform scenario; custom = the team's own. seed: type: object nullable: true properties: version: type: integer title: type: string trigger: type: string description: >- The classify's definition of the scenario, in a reader's words; not editable. goal: type: string max_steps: type: integer steps: type: array items: type: object properties: id: type: string minLength: 1 maxLength: 32 description: >- Stable inside the playbook (react, stage, reply, wait, followup, last_wait, task on the platform seeds); minted for an added step. kind: type: string enum: - react - move_stage - like_post - send_message - wait_for_reply - wait_until - create_task - find_people - reach_objective - use_playbook - resume_orchestration - stoplist_person enabled: type: boolean description: 'Off: never planned under this scenario.' locked: type: boolean description: >- Platform only: the step cannot be switched off, moved or removed (the stoplist step of do_not_contact). when: type: string nullable: true maxLength: 512 description: >- "Plan it when ...": the condition the planning turn judges; null = always. instructions: type: string nullable: true maxLength: 2048 description: >- What the step must do or say, the text the model reads; the product copy a team reads IS the prompt text. params: type: object additionalProperties: {} description: >- The kind's product parameters, each a value of its dictionary (see above). required: - id - kind - enabled - locked - when - instructions - params description: >- The seed's whole step list, the ones off by default included. required: - version - title - trigger - goal - max_steps - steps description: >- [ro] The platform seed under the key (null on a team's own scenario). playbook: type: object nullable: true properties: source: type: string enum: - platform - edited - custom key: type: string nullable: true description: >- The scenario key the playbook plays for; null only on a team's own scenario with steps of its own. version: type: integer description: The platform seed version the steps were taken from. goal: type: string max_steps: type: integer description: >- The ceiling the plan tool holds: the seed's plus the steps the team added. steps: type: array items: type: object properties: id: type: string minLength: 1 maxLength: 32 description: >- Stable inside the playbook (react, stage, reply, wait, followup, last_wait, task on the platform seeds); minted for an added step. kind: type: string enum: - react - move_stage - like_post - send_message - wait_for_reply - wait_until - create_task - find_people - reach_objective - use_playbook - resume_orchestration - stoplist_person enabled: type: boolean description: 'Off: never planned under this scenario.' locked: type: boolean description: >- Platform only: the step cannot be switched off, moved or removed (the stoplist step of do_not_contact). when: type: string nullable: true maxLength: 512 description: >- "Plan it when ...": the condition the planning turn judges; null = always. instructions: type: string nullable: true maxLength: 2048 description: >- What the step must do or say, the text the model reads; the product copy a team reads IS the prompt text. params: type: object additionalProperties: {} description: >- The kind's product parameters, each a value of its dictionary (see above). required: - id - kind - enabled - locked - when - instructions - params description: The enabled steps in order. instructions: type: string nullable: true description: >- The team's instructions over the steps (the row's compact context). level: type: string enum: - autopilot - copilot - conditional - 'off' description: >- The scenario's level as it stands: the row's, else the seed's (block AC4). conditions: type: array items: type: object properties: kind: type: string enum: - lead - no_answer description: >- lead: the team's words, judged by the classifier; no_answer: the built-in one, a question Knowledge has no answer for, read by unibox from the turn's missing-answer signal. when: type: string nullable: true maxLength: 255 description: >- A lead condition's words completing "when the lead ..." ("mentions a contract or a security review"), 3..255 chars; null on the built-in one. then: type: string enum: - copilot - 'off' description: >- What the reply gets when the condition holds: copilot (drafted for a person's OK) or off (nothing drafted). required: - kind - when - then description: >- A Conditional level's conditions in order; empty on any other level. required: - source - key - version - goal - max_steps - steps - instructions - level - conditions description: >- [ro] The effective playbook: the seed or the fork, enabled steps in order, the instructions over them. Null on a team's own scenario without steps of its own. default_changed: type: boolean description: >- [ro] True when the platform seed moved past the version the team's fork was taken from: compare and reset, or keep yours. required: - sid - team_sid - agent_sid - scenario_key - title - trigger - context - context_compact - steps - steps_base_version - level - conditions - created_by - match_count - last_matched_at - deleted_by - created_at - updated_at - deleted_at - source - seed - playbook - default_changed updated_fields: type: array items: type: string previous_values: type: object additionalProperties: {} kept_fields: type: array items: type: string description: >- The fields this write did not change because the person's own value stands on them (stamped person); read the item for what landed. meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - operation - item - updated_fields - previous_values - meta McpError: type: object properties: success: type: boolean enum: - false error: type: object properties: code: type: string enum: - validation_failed - nothing_to_update - not_found - relation_not_found - invalid_transition - limit_exceeded - payment_required - duplicate_rejected - conflict - delete_blocked - unauthorized - forbidden - rate_limited - internal_error - service_unavailable - not_implemented message: type: string recoverable: type: boolean suggestion: type: string field_errors: type: object additionalProperties: type: array items: type: object properties: rule: type: string message: type: string required: - rule - message blockers: type: array items: type: object properties: type: type: string description: >- Machine-readable blocker type (active_flow, pending_tasks, …). severity: type: string enum: - hard - soft description: >- hard = external action required; soft = acknowledge is enough. description: type: string entity_sid: type: string nullable: true count: type: integer resolution: type: string description: 'Hard: tool name to call. Soft: code for acknowledge[].' resolution_hint: type: string required: - type - severity - description - entity_sid - resolution - resolution_hint context: type: object additionalProperties: {} required: - code - message - recoverable meta: type: object properties: trace_id: type: string description: UUID v7; same 128-bit value as the X-Trace-Id header. span_id: type: string pattern: ^[0-9a-f]{16}$ description: 16 hex chars, root span of this request. timestamp: type: string description: ISO 8601 UTC (Y-m-dTH:i:sZ), response time. duration_ms: type: integer minimum: 0 description: Server-side wall clock. team_sid: type: string nullable: true description: >- The team this call ran in (the token team, or the team_sid override). Null when unauthenticated; absent from pre-2026-08-20 backends. actor_type: type: string nullable: true description: >- user | agent | api_key | system. Null when unauthenticated; absent from pre-2026-08-20 backends. required: - trace_id - span_id - timestamp - duration_ms required: - success - error responses: McpClientError: description: >- MCP error envelope. `error.code` is one of validation_failed, nothing_to_update, not_found, relation_not_found, invalid_transition, limit_exceeded, payment_required, duplicate_rejected, conflict, delete_blocked, unauthorized, forbidden, rate_limited, not_implemented. content: application/json: schema: $ref: '#/components/schemas/McpError' McpServerError: description: >- MCP error envelope with `error.code` internal_error or service_unavailable. content: application/json: schema: $ref: '#/components/schemas/McpError' securitySchemes: BearerJwt: type: http scheme: bearer bearerFormat: JWT description: >- 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. TeamSid: type: apiKey in: header name: Team-SID description: >- Team scope for tokens that do not carry one. Ignored when the token already names a team. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.