Start Data Sync

Initiates a new data synchronization process for the specified integration instance. This creates a sync session that allows you to upload data in batches. Only one active sync is allowed per instance at any time.

Prerequisites

  1. The integration instance must already be created and active.
  2. No other sync session should be active for the instance.
  3. Use a valid instance_id in the URL path.

Sync Workflow

  1. Start sync using this endpoint to receive a sync_id.
  2. Upload data in batches using the sync_id with the upload data endpoint.
  3. Finish sync to trigger data processing

Important Notes

  • If an active sync already exists, you must complete or abort it before starting a new one.
  • Use the returned sync_id for all data upload operations
  • Monitor sync progress through the instance's notification emails
Language
Credentials
Header
Click Try It! to start a request and see the response here!