Sign in
calendar

Request calendar sync

Changed on

Request synchronization of an owned calendar over a date range.

post/calendar/{id}/request-sync{format}

Request

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

Path parameters

format'.json' required
idstring 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

start_datetimestring date-time required
end_datetimestring date-time required
should_update_eventsboolean

Response

idinteger required
status'success' | 'failed' | 'in_progress' | 'not_started' required
  • success - Success
  • failed - Failed
  • in_progress - In Progress
  • not_started - Not Started
start_datetimestring date-time required
end_datetimestring date-time required
should_update_eventsboolean required
trigger_source'import' | 'manual' | 'webhook' | 'admin' required
  • import - Import
  • manual - Manual
  • webhook - Webhook
  • admin - Admin
error_messagestring required

Changes

  • 3ae1198a9fcdRevision changes
    • ○

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

  • 62d09f340968Revision changes
    • ○

      added the non-success response with the status

    • ○

      added the required property to the response with the status