Skip to main content
POST
Trigger Calendar Sync

Request

Calendar events are continuously synchronized in the background. Use this endpoint when you need the most recent events immediately (for example, before generating a day-start briefing).

Headers

string
Optional UUID to deduplicate retried sync requests within 24 hours.

Body Parameters

string
default:"incremental"
incremental (default) syncs only changes since the last successful sync. full rebuilds the entire calendar index; use sparingly as it can take several minutes on large accounts.
string
Optional provider override: google or microsoft. When omitted, every connected calendar in the workspace is refreshed.
string
ISO 8601 lower bound when mode is full. Defaults to 90 days before the current date.
string
ISO 8601 upper bound when mode is full. Defaults to 180 days after the current date.

Response

object
Responses include X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID. When the job completes, a calendar.sync.completed webhook event is delivered if you have a matching subscription.

Example Response

Errors