Skip to content

Start Import

EndpointMethod
/api/admin/settings/data-transfer/imports/{id}/startPOST

Processes the next pending batch of rows. Call this repeatedly until there are no pending batches left — each call advances the import and returns progress in the stats object. The {id} is the import id.

json
{ "stats": { "processed": 10, "total": 12, "invalid": 0 }, "import": { /* ... */ } }

The stats values above are illustrative.

Import lifecycle

A full import runs through these stages, in order:

  1. Create the import (uploads the file).
  2. Validate the file.
  3. Start — processes one batch per call; repeat until no pending batch remains.
  4. Link — runs the post-process linking stage.
  5. Index — runs the indexing stage.

Errors

ConditionStatus
Nothing left to import400
Import has not been validated / is not valid400
process_in_queue requested but the queue is not configured400

Permission: settings.data_transfer.imports.edit.

Released under the MIT License.