Force an on-demand synchronization of the workspace’s connected mailbox
incremental (default) fetches only messages newer than the last successful sync. full rebuilds the entire mailbox index and may take several minutes.gmail or microsoft. When omitted, all connected providers are synced.X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID headers. Jobs typically complete within 10 seconds for incremental mode; long-running full syncs are reported via the email.sync.completed webhook event.
| Status | Code | Description |
|---|---|---|
| 401 | invalid_key | Invalid or expired API key |
| 403 | insufficient_permissions | Missing write:email permission, or no mailbox connected |
| 409 | sync_in_progress | A full sync is already running; wait for it to finish before starting another |
| 429 | rate_limited | Too many sync requests; on-demand sync is capped at 6 per hour per workspace |