The Only API docs
Bulk Import

Cancel an import job

Stop an import. Cancellation is cooperative: pending rows are canceled at once and nothing further is claimed, but a row already mid-login runs to completion — we cannot…

POST
/import/jobs/{job_id}/cancel

Stop an import. Cancellation is cooperative: pending rows are canceled at once and nothing further is claimed, but a row already mid-login runs to completion — we cannot un-send a login attempt — and records its real outcome. Expect a few more successes after cancelling.

Only a queued or running job can be canceled.

X-API-Key<token>

Your CRM panel API key

In: header

Path Parameters

job_id*string

Import job ID (32-character hex) returned by POST /import/jobs.

Response Body

application/json

curl -X POST "https://example.com/import/jobs/string/cancel"
{  "canceled_rows": null,  "counts": null,  "job": null,  "success": true}