Sign in

Cancel a file import

Sets cancellation_requested_at so the running job exits cleanly to cancelled on its next heartbeat. Idempotent — re-cancelling just bumps the timestamp.

post/file_imports/{id}/cancel

Path parameters

idstring required

Response

Cancel accepted

idinteger
status'pending' | 'processing' | 'replicating' | 'completed' | 'failed' | 'cancelled'
sourcestring nullable

Origin of the import (e.g. csv, nacha, bulk_api)

filenamestring nullable
total_itemsinteger
processed_itemsinteger
successful_itemsinteger
failed_itemsinteger
skipped_itemsinteger

Records skipped due to on_conflict: skip matching an existing external_id

expected_records_countinteger nullable
progressinteger

processed_items / total_items as a percentage (0-100)

parsingboolean

True until rows start landing; file totals are unknown while parsing

decimal_placesinteger

Number of decimal places (2 for USD)

stuckboolean

Currently processing with no heartbeat for >5 minutes

on_conflictstring nullable
error_messagestring nullable
error_detailsobject nullable
data_stream_idsinteger[]
created_atstring date-time
started_atstring date-time nullable
records_written_atstring date-time nullable
completed_atstring date-time nullable
last_progress_atstring date-time nullable
cancellation_requested_atstring date-time nullable
urlstring

e.g. /v1/file_imports/123

records_urlstring

e.g. /v1/file_imports/123/records

record_countinteger

Aggregate; stream-scoped index only

total_creditsinteger

Aggregate, in cents; stream-scoped index only

total_debitsinteger

Aggregate, in cents; stream-scoped index only

net_amountinteger

Aggregate: credits minus debits, in cents; stream-scoped index only

date_range_startstring date nullable

Aggregate; stream-scoped index only

date_range_endstring date nullable

Aggregate; stream-scoped index only

currencystring nullable

Aggregate; stream-scoped index only

Changes

Changed in 1 of the 6 revisions of this API.1