WHwhispa
scenarios

Update Scenario

Update an existing 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)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Path parameters

scenario_idstring uuid required

Request body

display_namestring nullable

Human-readable name

descriptionstring nullable

Detailed description of the scenario

action_cards_prompt_idstring uuid nullable

ID of the action cards prompt

suggested_responses_prompt_idstring uuid nullable

ID of the suggested responses prompt

coaching_prompt_idstring uuid nullable

ID of the coaching prompt

summary_prompt_idstring uuid nullable

ID of the call summary prompt

tagging_prompt_idstring uuid nullable

ID of the call tagging prompt

tool_namesstring[] nullable

Associated tool names

scenario_metadataobject nullable

Additional metadata

is_activeboolean nullable

Whether scenario is active

modestring nullable

Scenario mode: 'training' or 'production'

customer_simulation_promptstring nullable

Customer simulation prompt for training mode

scorecard_template_keystring nullable

QA scorecard template key for this scenario. Set to null to fall back to QA_SCORECARD_DEFAULT_TEMPLATE.

Response

Successful Response

idstring uuid required
namestring required
display_namestring required
descriptionstring required
action_cards_prompt_idstring uuid nullable
suggested_responses_prompt_idstring uuid nullable
coaching_prompt_idstring uuid nullable
summary_prompt_idstring uuid nullable
tagging_prompt_idstring uuid nullable
tool_namesstring[] required
scenario_metadataobject required
is_activeboolean required
is_defaultboolean required
modestring required
scorecard_template_keystring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

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