Sign in

v3

latestOpenAPI 3.0.32026-07-31112307733.3 KB
calendar-v2

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
meeting_platform'zoom' | 'google_meet' | 'goto_meeting' | 'microsoft_teams' | 'microsoft_teams_live' | 'webex' | 'chime_sdk' | 'webrtc' | 'zoom_rtms' | 'google_meet_media_api' | 'slack_authenticator' | 'slack_huddle_observer' 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