Skip to main content
PUT
Update a scenario

Authorizations

Authorization
string
header
required

API key from waterr.ai/settings?tab=api-keys. Send as Authorization: Bearer wai_<your_key>.

Path Parameters

id
string
required

Body

application/json
name
string
Maximum string length: 100
description
string
prompt
string
user_prompt
string

Original user prompt entered on Create page

welcome_message
string
type
enum<string>
Available options:
interview,
roleplay,
upskill,
brainstorm
persona_id
string
data_model_id
string

ID of the associated data model (optional)

goals
string[]
visibility
enum<string>
Available options:
public,
restricted
webhook_url
string
redirect_url
string
language
string

BCP-47 language tag biasing STT/TTS for the session.

maxDuration
integer

Maximum session duration in minutes.

max_participants
integer
allow_screen_share
boolean
allow_participant_video
boolean
allow_participant_audio
boolean
allow_recording
boolean
allow_transcription
boolean
allow_chat
boolean
allow_live_vision
boolean
use_gpt_vision
boolean
deep_think
boolean
auto_analysis
boolean
waiting_room_enabled
boolean
auto_admit
boolean
end_call_enabled
boolean
prejoin_camera_on
boolean
eager_bot_join
boolean
use_own_keys
boolean
controls
object

Free-form per-scenario control overrides (camera, mic, share, etc.).

Response

Scenario updated successfully

id
string
name
string
description
string
prompt
string
user_prompt
string
type
enum<string>
Available options:
interview,
roleplay,
upskill,
brainstorm
persona_id
string
org_id
string
created_at
string<date-time>
updated_at
string<date-time>