Company logoTrust Center Documentation
API v1 ReferenceImportsIdCancel

Cancel an import

Stop an import before it is written and delete the uploaded file. An import that is already queued for commit, committing or completed cannot be cancelled.

POST
/api/v1/imports/{id}/cancel

Stop an import before it is written and delete the uploaded file. An import that is already queued for commit, committing or completed cannot be cancelled.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Import session identifier

Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v1/imports/550e8400-e29b-41d4-a716-446655440000/cancel"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "state": "cancelled"}

How is this guide?