Create an import job

Módulo Platform

POST/import-jobsimportJobs.create

A spreadsheet import through detect, map, validate, deduplicate, dry run and commit. Creates an import job. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requiere la capacidad data.classification.write.
Alcances de OAuth: data.
Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: ImportJobCreate

importJobs.create: ImportJobCreate
Campo	Tipo	Obligatorio	Descripción
import_mapping_profile_id	string (uuid) \| null	No	Identifier of the saved mapping profile.
target_code	string	Sí	Import target the rows are written to.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
source	"CSV" \| "XLSX" \| "XLS" \| "Google Sheets"	Sí	Source format.
original_filename	string	Sí	File name as uploaded.Restricciones: length 1 to 255
storage_object_path	string	Sí	Object path of the uploaded file in the tenant import bucket.Restricciones: length 1 to 1024

{
  "import_mapping_profile_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "target_code": "vendors",
  "source": "CSV",
  "original_filename": "vendors-2026.xlsx",
  "storage_object_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/imports/vendors-2026.xlsx"
}

Respuesta 201: ImportJob

importJobs.create: ImportJob
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the import job.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
import_mapping_profile_id	string (uuid) \| null	Sí	Identifier of the saved mapping profile.
target_code	string	Sí	Import target the rows are written to.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
source	"CSV" \| "XLSX" \| "XLS" \| "Google Sheets"	Sí	Source format.
original_filename	string	Sí	File name as uploaded.Restricciones: length 1 to 255
storage_object_path	string	Sí	Object path of the uploaded file in the tenant import bucket.Restricciones: length 1 to 1024
import_status	"Uploaded" \| "Detected" \| "Mapped" \| "Validated" \| "Committing" \| "Committed" \| "Undone" \| "Failed" \| "Canceled"	Sí	Wizard progress.
mapping_confirmed_at	string (date-time) \| null	Sí	When the person confirmed every column mapping; nothing is validated before it.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "import_mapping_profile_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "target_code": "vendors",
  "source": "CSV",
  "original_filename": "vendors-2026.xlsx",
  "storage_object_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/imports/vendors-2026.xlsx",
  "import_status": "Uploaded",
  "mapping_confirmed_at": "2026-10-08T14:30:00Z"
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/import-jobs" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"import_mapping_profile_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","target_code":"vendors","source":"CSV","original_filename":"vendors-2026.xlsx","storage_object_path":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/imports/vendors-2026.xlsx"}'

const { data } = await xos.importJobs.create({
    "import_mapping_profile_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "target_code": "vendors",
    "source": "CSV",
    "original_filename": "vendors-2026.xlsx",
    "storage_object_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/imports/vendors-2026.xlsx"
  });

response = xos.import_jobs.create({"import_mapping_profile_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "target_code": "vendors", "source": "CSV", "original_filename": "vendors-2026.xlsx", "storage_object_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/imports/vendors-2026.xlsx"})

xos import-jobs create --data '{"import_mapping_profile_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","target_code":"vendors","source":"CSV","original_filename":"vendors-2026.xlsx","storage_object_path":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/imports/vendors-2026.xlsx"}'