Sign in
calendar

Changed on

ViewSet for managing calendars.

post/calendar/bundle{format}

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in cookie sessionid

Path parameters

format'.json' required

Headers

X-Organization-Idstring

Selects the active organization for this request. Optional for callers that belong to exactly one active organization — the single membership is resolved implicitly. Required when the caller has two or more active memberships; omitting it in that case returns 400. If the header names an organization the caller is not an active member of, the server returns 403.

Request body

namestring required
bundle_calendarsinteger[] required
primary_calendarinteger nullable required

Response

idinteger required
namestring required
descriptionstring
emailstring email required
external_idstring required
provider'internal' | 'google' | 'microsoft' | 'apple' | 'ics' required
  • internal - Internal Calendar
  • google - Google Calendar
  • microsoft - Microsoft Outlook Calendar
  • apple - Apple Calendar
  • ics - ICS
calendar_type'personal' | 'resource' | 'virtual' | 'bundle' required
  • personal - Personal Calendar
  • resource - Resource Calendar
  • virtual - Virtual Calendar
  • bundle - Bundle Calendar
capacityinteger nullable

The maximum number of attendees that can be accommodated in this calendar's events. This is only applicable for resource calendars.

manage_available_windowsboolean

If true, this calendar can manage its own available time windows. If not, it will use the available time windows of the external calendar it's attached to.

visibility'active' | 'unlisted' | 'inactive'
  • active - Active
  • unlisted - Unlisted
  • inactive - Inactive
sync_enabledboolean

Whether this calendar's events are pulled from the external provider. Set to False to skip syncing calendars that aren't useful for scheduling — holidays, birthdays, organization-wide events, etc. When False, no new CalendarSync is requested for this calendar (including webhook- and import-triggered syncs); previously synced events are left untouched. Default True keeps existing calendars syncing as before.

Changes

  • 408c86eb5933Revision changes
    • ▲

      the response property became optional for the status

    • ○

      the response required property became not read-only for the status

  • 3ae1198a9fcdRevision changes
    • ○

      added the new optional header request parameter X-Organization-Id