DocsAPI ReferenceUpdate a bot (scheduled only)
PATCH/api/v1/bots/{bot_id}

Updates fields on a bot that has not yet started — status must be `requested` or `scheduled`. Returns `409` if the bot is already active, stopping, completed, or failed.

Path Parameters

bot_idstringrequirede.g. "550e8400-e29b-41d4-a716-446655440000"

Bot UUID.

Headers

X-API-Keystringrequired

Your workspace API key.

Content-Typestringrequired

Must be `application/json`.

Request Body

application/json

bot_namestring

New display name for the bot.

Example: "Updated Notetaker"

languagestring

New transcription language code.

Example: "fr"

recording_enabledboolean

Enable or disable recording.

Example: false

transcribe_enabledboolean

Enable or disable transcription.

Example: true

voice_agent_enabledboolean

Enable or disable voice agent.

Example: false

capture_modesarray

Updated capture modes.

Example: ["audio"]

recording_formatstring

Recording output format.

Example: "mp3"

mp4mp3webm

Responses

200Updated bot object.
404Bot not found in this workspace.
409Bot is already active, stopping, completed, or failed.