PatchedPatchBotRequest

Mixin class providing validation for common attributes used in both patching and creating bots.

bot_image
Type: object · BotImageRequest

The image for the bot
- data
  Type: string
  min length:
  1
  required
  
  Base64 encoded image data.
- type
  Type: string · TypeEnumenum
  required
  
  Image content type. Supported formats: PNG and JPEG.
  
  image/png - PNG Image
  
  image/jpeg - JPEG Image
  
  values
  image/png
  image/jpeg
bot_name
Type: string
min length:
1

The name of the bot, e.g. 'My Bot'
join_at
Type: stringFormat: date-time

The time the bot should join the meeting. ISO 8601 format, e.g. 2025-06-13T12:00:00Z
meeting_url
Type: string
min length:
1

The URL of the meeting to join, e.g. https://zoom.us/j/123?pwd=456
metadata
Type: object

JSON object containing metadata to associate with the bot
recording_settings
Type: object

The settings for the bot's recording. The settings specified here will completely replace the existing settings.
- format
  Type: string
  
  The format of the recording to save. The supported formats are 'mp4', 'mp3' and 'none'. Defaults to 'mp4'.
- record_async_transcription_audio_chunks
  Type: boolean
  
  Whether to record additional audio data which is needed for creating async (post-meeting) transcriptions. Defaults to false.
- record_chat_messages_when_paused
  Type: boolean
  
  Whether to record chat messages even when the recording is paused. Defaults to false.
- reserve_additional_storage
  Type: boolean
  
  Whether to reserve extra space to store the recording. Only needed when the bot will record video for longer than 6 hours. Defaults to false.
- resolution
  Type: stringenum
  
  The resolution to use for the recording. The supported resolutions are '1080p' and '720p'. Defaults to '1080p'.
  
  values
  1080p
  720p
- view
  Type: string
  
  The view to use for the recording. The supported views are 'speaker_view', 'gallery_view' and 'speaker_view_no_sidebar'.