Trigger Calendar Sync
Calendar
Trigger Calendar Sync
Force an on-demand synchronization of the connected calendars in the workspace
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
Optional UUID to deduplicate retried sync requests within 24 hours.
Body Parameters
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.Optional provider override:
google or microsoft. When omitted, every connected calendar in the workspace is refreshed.ISO 8601 lower bound when
mode is full. Defaults to 90 days before the current date.ISO 8601 upper bound when
mode is full. Defaults to 180 days after the current date.Response
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
| Status | Code | Description |
|---|---|---|
| 401 | invalid_key | Invalid or expired API key |
| 403 | insufficient_permissions | Missing write:calendar permission, or no connected calendar |
| 409 | sync_in_progress | A full sync is already running |
| 429 | rate_limited | On-demand sync is capped at 6 per hour per workspace |