Cancel an eligible active import without deleting retained evidence.

Authorization

bearerToken

AuthorizationBearer <token>

In: header

Path Parameters

importRef*string

Formatuuid

Header Parameters

X-Tenant-ID*string

Opaque external tenant reference.

Formatuuid

Idempotency-Key*string

Match^[A-Za-z0-9][A-Za-z0-9._:-]*$

Length16 <= length <= 128

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

reason*string

Length1 <= length <= 500

Response Body

`application/json`

curl -X POST "https://example.com/api/platform/v1/imports/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \  -H "X-Tenant-ID: 497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "Idempotency-Key: stringstringstri" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'

{  "data": {    "import": {      "ref": "d0fad5d6-e996-4437-8fb9-5f40bbcfd7cc",      "state": "created",      "source": "string",      "provider": "string",      "report_type": "string",      "statement_period": {        "start": "2019-08-24",        "end": "2019-08-24"      },      "expected_bytes": 1,      "schema_fingerprint": "string",      "counts": {        "accepted": 0,        "rejected": 0      },      "reconciliation": {},      "file": null,      "mapping": null,      "profiling": null,      "profile": {},      "terminal_reason": "string",      "published_at": "2019-08-24T14:15:22Z",      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  }}

Authorization

Path Parameters

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`