Skip to main content

Start a full load of a resource

POST 
/v1/sync-runs

A full load that never empties the table part-way: start a run, send every record in batches with ?sync_run_id=ID, then complete it.

Completing removes (soft delete) the records of this source system that no batch of the run touched; failing it changes nothing. A run left open for 24 hours expires.

One open run per resource and source system. A run that saw no record at all refuses to complete (sync_run_empty), so a broken export can never wipe the data.

Resources: supplier, organization, purchase_order, purchase_order_line, receipt, user, customer_data_table_1 .. customer_data_table_20. The resource's write right is needed.

Request​

Responses​

The open run