DELETE https://api.veriko.mx/v1/beneficiaries/imports/{id}

Cancel an import job

Audience
public
Auth
API key
Permission
beneficiaries:create
How-to guide →

Cancels an import job that has not been confirmed yet (pending, parsing or preview_ready). For jobs in terminal states (completed, failed, cancelled) or already committing returns 404. Accounts already persisted by a previous commit must be archived individually with DELETE /v1/beneficiaries/{id}.

Parameters
Parameter In Type Required Description
id * path integer required

Numeric ID of the import job.

Request
curl -X DELETE 'https://api.veriko.mx/v1/beneficiaries/imports/{id}' \
  -H 'Authorization: Bearer mxcep_••••' \
  -H 'Content-Type: application/json'

Python example — coming soon.

JavaScript example — coming soon.

PHP example — coming soon.

Response status codes DELETE /v1/beneficiaries/imports/{id}
Status Class Description Body
204 2xx Job cancelled. No body. No body
401 4xx Authentication is required or the provided credentials are invalid. ErrorResponse
403 4xx Permisos insuficientes ErrorResponse
404 4xx Job does not exist or is in a terminal state. ErrorResponse
Errors from DELETE /v1/beneficiaries/imports/{id}
Status Code Detail
401 unauthorized

Invalid or missing authentication credentials.

Envelope
meta.request_id
c4d5e6f7a8b9
403 forbidden

You do not have permission to access this resource.

Envelope
meta.request_id
d5e6f7a8b9c0
404 not_found

Import job not found or already terminal.

Envelope
meta.request_id
f8a9b0c1d2e3