Execute Data Import
POST/api/v2/data-imports/:dataImport/execute
Executes a validated data import. Kicks off the background import job and returns a tracked job log ID to monitor progress.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Per-entity authorization: For the gated entity types (customers, warehouses, suppliers, sales_reps, categories) the user must hold the matching <entity>.import permission for the import's entity_type. Returns 403 when the user lacks the required permission. The check resolves through the granular_permissions feature flag — it is a no-op while that flag is off.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Validation failed — the body is a field → messages map (Laravel shape) or the platform envelope with a stable machine-readable code. Fix the payload and resubmit.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.