Skip to content

Undo an import batch

Platform module

POST/import-batches/{id}/undoimportBatches.undo

Rolls back the batch within 7 days. Rows a later edit depends on are listed in a refusal instead of deleted. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.

  • Requires the capability data.classification.write.
  • OAuth scopes: data.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 404, 409, 422, 429. Errors are RFC 9457 problem details.

Path and query parameters

importBatches.undo: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the import batch.

Response 200: ImportBatch

importBatches.undo: ImportBatch
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the import batch.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
import_job_idstring (uuid)YesIdentifier of the import job.
committed_atstring (date-time) | nullYesWhen the batch was committed.
undone_atstring (date-time) | nullYesWhen the batch was undone.
undo_reasonstring | nullYesWhy the batch was undone.Constraints: length 1 to 2000
{
  "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_job_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "committed_at": "2026-10-08T14:30:00Z",
  "undone_at": "2026-10-08T14:30:00Z",
  "undo_reason": "Wrong sheet imported."
}

Code samples

curl -X POST "$XOS_BASE_URL/import-batches/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/undo" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
const { data } = await xos.importBatches.undo("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.import_batches.undo("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos import-batches undo 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f