How to Do a Historical Sync Using the REST API

Question

How can I do a historical sync using the REST API?

Environment

REST API

Answer

To trigger a historical sync, send a PATCH request to the Update a Connection endpoint. Set the is_historical_sync parameter to TRUE to start a historical sync. When you set this parameter to TRUE, we start the historical sync immediately. If a sync is currently running, we cancel it and restart it as a historical sync. After the historical sync completes, all subsequent syncs are incremental.

The connection must not be paused when you send the request. If the connection is paused, the historical sync flag is set but the sync doesn't start until the connection is unpaused.

How long the historical sync takes depends on the amount of data and the limitations of your source. For connections with large data volumes, the historical sync can take several days to complete.