Update Scheduled Bot

patch

https://us-east-1.recall.ai/api/v1/bot/{id}/

Update a Scheduled Bot.

The base rate limit for this endpoint is:

300 requests per min per workspace

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

❗️
In production, use scheduled bots by setting the join_at parameter to a time at least 10 minutes in the future to guarantee your bot will join on time.
You should use ad-hoc bots sparingly, only when your use case requires it (e.g. for spontaneous meetings). You can create ad-hoc bots by omitting the join_at or setting it to a time that is less than 10 minutes in the future.

See here for details on how the bot's join_at affects your ability to update bots.

To update bots created via the Calendar V2 integration, you cannot update bots using this endpoint and will need to use the Schedule Bot For Calendar Event endpoint instead.

Use this endpoint to:

Reschedule a bot that has not joined yet by updating its join_at time before the meeting starts.
Move a scheduled bot to a different meeting by changing its meeting_url before it joins.
Update how a scheduled bot will behave in the call, including its recording, chat, automatic leave, and breakout room settings, before it joins.
Update bot metadata or display settings before join so the scheduled bot stays aligned with your app’s internal records and meeting workflow.

Path Params

uuid

required

A UUID string identifying this bot.

Body Params

meeting_url

string

The url of the meeting. For example, https://zoom.us/j/123?pwd=456. This field will be cleared a few days after the bot has joined a call.

bot_name

string

length between 1 and 100

Defaults to Meeting Notetaker

The name of the bot that will be displayed in the call.
(Note: Authenticated Google Meet bots will use the Google account name and this field will be ignored.)

join_at

date-time | null

The time at which the bot will join the call, formatted in ISO 8601. This field can only be read from scheduled bots that have not yet joined a call.

recording_config

object | null

Configure the recording generated by the bot. Includes options for getting meeting transcript, the layout of the recorded video, when to start recording and more.

output_media

object | null

Settings for the bot output media.

automatic_video_output

object | null

Settings for the bot to output video. Image should be 16:9. Read more about this here: https://docs.recall.ai/docs/output-video-in-meetings

automatic_audio_output

object | null

Settings for the bot to output audio.

chat

object | null

Settings for the bot to send chat messages.
(Note: Chat functionality is only supported for Zoom, Google Meet and Microsoft Teams currently.)

automatic_leave

object | null

variant

object | null

Configure bot variants per meeting platforms, e.g. {"zoom": "web_4_core"}.

zoom

object | null

Zoom specific parameters

google_meet

object | null

Google Meet specific parameters

webex

object | null

Webex specific parameters

breakout_room

object | null

Configure how the bot handles breakout rooms. Currently, Zoom is supported.Examples: {"mode": "join_main_room"} | {"mode": "join_specific_room", "room_id": ""} | {"mode": "auto_accept_all_invites"} (default).

metadata

object

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Response

Use this endpoint to:

200