DocsAPI ReferenceReschedule or update settings
PATCH/api/v1/bots/schedule/{bot_id}

Can only update bots with status `scheduled`. All fields optional — only provided fields are updated.

Path Parameters

bot_idintegerrequirede.g. 7

Scheduled bot integer ID.

Headers

X-API-Keystringrequired

Your workspace API key.

Content-Typestringrequired

Must be `application/json`.

Request Body

application/json

meeting_urlstring

New meeting URL.

Example: "https://meet.google.com/xyz-abcd-efg"

scheduled_start_atstring

New scheduled start time (must be in the future).

Example: "2026-05-15T15:00:00Z"

join_offset_secondsinteger

New join offset in seconds.

Example: -60

recording_enabledboolean

Enable or disable recording.

Example: false

transcribe_enabledboolean

Enable or disable transcription.

Example: true

voice_agent_enabledboolean

Enable TTS/voice agent.

Example: false

capture_modesarray

Updated capture modes.

Example: ["audio"]

recording_formatstring

Recording output format.

Example: "mp3"

mp4mp3webm

Responses

200Updated scheduled bot entry.
400New `scheduled_start_at` is in the past.
404Not found or already launched/cancelled.