> ## Documentation Index
> Fetch the complete documentation index at: https://docs.waterr.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a scenario



## OpenAPI

````yaml PUT /scenarios/{id}
openapi: 3.0.0
info:
  title: WaterrAI API
  version: 1.0.0
  description: >-
    REST API for the WaterrAI meeting platform — create scenarios, spin up
    AI-driven meetings, fetch transcripts and analyses.
  contact:
    name: Support
    email: harshit@waterr.ai
servers:
  - url: https://api.waterr.ai/v1
    description: Production
security:
  - apiKeyAuth: []
tags:
  - name: Users
  - name: Personas
  - name: Voices
  - name: Scenarios
  - name: Goals
  - name: Meetings
  - name: Analyses
  - name: Recordings
  - name: Transcripts
  - name: Tools
    description: >-
      Account-scoped custom function (tool) definitions the LLM can call
      mid-meeting.
  - name: Scenario Tools
    description: >-
      Per-scenario attachments linking a scenario to one or more tool
      definitions.
paths:
  /scenarios/{id}:
    put:
      tags:
        - Scenarios
      summary: Update a scenario
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  maxLength: 100
                description:
                  type: string
                prompt:
                  type: string
                user_prompt:
                  type: string
                  description: Original user prompt entered on Create page
                welcome_message:
                  type: string
                type:
                  type: string
                  enum:
                    - interview
                    - roleplay
                    - upskill
                    - brainstorm
                persona_id:
                  type: string
                data_model_id:
                  type: string
                  description: ID of the associated data model (optional)
                goals:
                  type: array
                  items:
                    type: string
                visibility:
                  type: string
                  enum:
                    - public
                    - restricted
                webhook_url:
                  type: string
                redirect_url:
                  type: string
                language:
                  type: string
                  description: BCP-47 language tag biasing STT/TTS for the session.
                maxDuration:
                  type: integer
                  description: Maximum session duration in minutes.
                max_participants:
                  type: integer
                allow_screen_share:
                  type: boolean
                allow_participant_video:
                  type: boolean
                allow_participant_audio:
                  type: boolean
                allow_recording:
                  type: boolean
                allow_transcription:
                  type: boolean
                allow_chat:
                  type: boolean
                allow_live_vision:
                  type: boolean
                allow_web_search:
                  type: boolean
                use_gpt_vision:
                  type: boolean
                deep_think:
                  type: boolean
                auto_analysis:
                  type: boolean
                waiting_room_enabled:
                  type: boolean
                auto_admit:
                  type: boolean
                end_call_enabled:
                  type: boolean
                prejoin_camera_on:
                  type: boolean
                eager_bot_join:
                  type: boolean
                consent_required:
                  type: boolean
                consent_message:
                  type: string
                use_own_keys:
                  type: boolean
                controls:
                  type: object
                  description: >-
                    Free-form per-scenario control overrides (camera, mic,
                    share, etc.).
      responses:
        '200':
          description: Scenario updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Scenario'
        '404':
          description: Scenario not found
        '500':
          description: Server error
      security:
        - apiKeyAuth: []
components:
  schemas:
    Scenario:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        prompt:
          type: string
        user_prompt:
          type: string
        type:
          type: string
          enum:
            - interview
            - roleplay
            - upskill
            - brainstorm
        persona_id:
          type: string
        org_id:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
  securitySchemes:
    apiKeyAuth:
      type: http
      scheme: bearer
      bearerFormat: wai_...
      description: >-
        API key from waterr.ai/settings?tab=api-keys. Send as `Authorization:
        Bearer wai_<your_key>`.

````