---
title: "Update Scenario"
method: PUT
path: "/scenarios/{scenario_id}"
tags: ["scenarios"]
---

# Update Scenario

`PUT /scenarios/{scenario_id}`

## Request

- Base URL: `https://dev.whispa.net` (the document declares no server; this is the origin it was published from)
- URL: `https://dev.whispa.net/scenarios/{scenario_id}`
- Auth: one of:
  - OAuth 2
    - Password
    - Token URL: `auth/bearer/login`
  - API key in cookie `access_token`

Update an existing scenario.

## Path parameters

- `scenario_id` string, uuid, required

## Request body

- ScenarioUpdate: Input schema for updating an existing scenario.
  - `display_name` string, nullable: Human-readable name
  - `description` string, nullable: Detailed description of the scenario
  - `action_cards_prompt_id` string, uuid, nullable: ID of the action cards prompt
  - `suggested_responses_prompt_id` string, uuid, nullable: ID of the suggested responses prompt
  - `coaching_prompt_id` string, uuid, nullable: ID of the coaching prompt
  - `summary_prompt_id` string, uuid, nullable: ID of the call summary prompt
  - `tagging_prompt_id` string, uuid, nullable: ID of the call tagging prompt
  - `tool_names` string[], nullable: Associated tool names
  - `scenario_metadata` object, nullable: Additional metadata
  - `is_active` boolean, nullable: Whether scenario is active
  - `mode` string, nullable: Scenario mode: 'training' or 'production'
  - `customer_simulation_prompt` string, nullable: Customer simulation prompt for training mode
  - `scorecard_template_key` string, nullable: QA scorecard template key for this scenario. Set to null to fall back to QA_SCORECARD_DEFAULT_TEMPLATE.

## Response `200`

Successful Response

- ScenarioResponse: Response data for a scenario.
  - `id` string, uuid, required
  - `name` string, required
  - `display_name` string, required
  - `description` string, required
  - `action_cards_prompt_id` string, uuid, nullable
  - `suggested_responses_prompt_id` string, uuid, nullable
  - `coaching_prompt_id` string, uuid, nullable
  - `summary_prompt_id` string, uuid, nullable
  - `tagging_prompt_id` string, uuid, nullable
  - `tool_names` string[], required
  - `scenario_metadata` object, required
  - `is_active` boolean, required
  - `is_default` boolean, required
  - `mode` string, required
  - `scorecard_template_key` string, nullable
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/whispa/apis/whispa-api.md) - [All operations](https://skmtc.dev/whispa/apis/whispa-api/llms.txt) - [OpenAPI document](https://skmtc.dev/whispa/apis/whispa-api/revisions/12c2e4aca43c?raw)
