Start a business record import job
POST/api/v2/imports
Step 2 of the import flow. Call this after POST /api/v2/imports/upload
with the filePath (fd) returned by it, plus a mapping of file columns
to the target form's fields. This queues the import job asynchronously —
records are created in the background, not synchronously in this call.
Before calling this: call GET /api/v2/form?formId={formId}&moduleId={moduleId}
to fetch the form's fields (fieldId, fieldName, isRequired, typeCode).
Use each field's fieldId as the value in fieldMapping below — mapping
an unknown fieldId, or omitting a required field, returns a 400.
Required Permissions: IMPORT permission on the target moduleId.
Request
Responses
- 200
- 400
- 403
Import job queued successfully
Missing/invalid required field, invalid moduleId/formId, or a required form field is not mapped
User does not have IMPORT permission for this module