Schedule Bot For Calendar Event

Schedule a bot for a calendar event. This endpoint will return the updated calendar event in response.

The base rate limit for this endpoint is:

600 requests per min per workspace

post/api/v2/calendar-events/{id}/bot/

Path parameters

idstring uuid required

A UUID string identifying this calendar event.

Request body

deduplication_keystring required

Pass this key to deduplicate bots across multiple calendar events. Please ensure this remains consistent across all calendar events that must share a single bot. For more details, refer to Calendar V2 scheduling guide.

Response

idstring uuid required

start_timestring date-time required

end_timestring date-time required

calendar_idstring uuid required

{"stackTrail":"components:schemas:CalendarEvent:properties:raw","oasType":"schema","type":"unknown","description":"The raw calendar event data from the calendar provider. The schema depends on the platform:\n\n- **Google Calendar**: [Event resource](https://developers.google.com/workspace/calendar/api/v3/reference/events#resource)\n- **Microsoft Outlook**: [Event resource](https://learn.microsoft.com/en-us/graph/api/resources/event?view=graph-rest-1.0#properties)"}

platformstring required

platform_idstring required

ical_uidstring required

zoom - Zoom
google_meet - Meet
goto_meeting - Goto
microsoft_teams - Teams
microsoft_teams_live - Teams Live
webex - Webex
chime_sdk - Chime Sdk
webrtc - Webrtc
zoom_rtms - Zoom Rtms
google_meet_media_api - Google Meet Media Api
slack_authenticator - Slack Authenticator
slack_huddle_observer - Slack Huddle Observer

meeting_urlstring nullable required

created_atstring date-time required

updated_atstring date-time required

is_deletedboolean required

Changes

Changed in 1 of the 6 revisions of this API.1128

Jul 26, 202601244e56b3a11128See the full diff
- ▲
  the bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/ request property type/format changed from object/ to / (media type: application/json)
  request-property-type-changed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/events (media type: application/json)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/events (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/events (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/metadata (media type: application/json)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/metadata (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/metadata (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/type (media type: application/json)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/type (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/type (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/url (media type: application/json)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/url (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/url (media type: multipart/form-data)
  request-property-removed
- ○
  added discriminator to bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/ request property (media type: application/json)
  request-property-discriminator-added
- ○
  added discriminator to bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/ request property (media type: application/x-www-form-urlencoded)
  request-property-discriminator-added
- ○
  added discriminator to bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/ request property (media type: multipart/form-data)
  request-property-discriminator-added
- ○
  added BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointRtmpRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebsocketRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebhookRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointDesktopSdkCallbackRequest to the bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/ request property oneOf list (media type: application/json)
  request-property-one-of-added
- ○
  added BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointRtmpRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebsocketRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebhookRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointDesktopSdkCallbackRequest to the bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/ request property oneOf list (media type: application/x-www-form-urlencoded)
  request-property-one-of-added
- ○
  added BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointRtmpRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebsocketRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebhookRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointDesktopSdkCallbackRequest to the bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/ request property oneOf list (media type: multipart/form-data)
  request-property-one-of-added
- ○
  the bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/ request property type/format was generalized from object/ to / (media type: application/x-www-form-urlencoded)
  request-property-type-generalized
- ○
  the bot_config/allOf[CalendarEventAddBotConfigSchemaRequest]/recording_config/allOf[BotRecordingConfigRequest]/realtime_endpoints/items/ request property type/format was generalized from object/ to / (media type: multipart/form-data)
  request-property-type-generalized
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history