Sign in
calendar-v2

Schedule Bot For Calendar Event

Changed on

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

This endpoint is rate limited to:

  • 600 requests per min per workspace
post/api/v2/calendar-events/{id}/bot/

Request

  • Base URL: https://us-east-1.recall.ai
  • URL: https://us-east-1.recall.ai/api/v2/calendar-events/{id}/bot/
  • Auth: API key in header Authorization

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 remain consistent across all calendar events that mush share a single bot. For more details, refer to Calendar V2 scheduling guide.

bot_configobject required

The config object(JSON) to be passed to the bot. It supports all properties available in Create Bot request.

meeting_url - automatically populated from the calendar event unless specified in bot_config. join_at - automatically populated from the calendar event

Response

idstring uuid required
start_timestring date-time required
end_timestring date-time required
calendar_idstring uuid required
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

Changes

  • f4bb0a29edc7Revision changes
    • breaking

      added to the response property oneOf list for the response status

  • 4a6be6e2acb8Revision changes
    • breaking

      the // response's property type changed from no type to string for status

    • breaking

      the response's property type changed from no type to string for status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 from the // response property oneOf list for the response status

    • info

      removed subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 from the response property oneOf list for the response status