Developers
Imports10

Update an import

PATCH/imports/{import_id}

Updates the duplicate policy of an import or restores it from the trash by setting deleted to false. To delete an import, use the delete operation.

The duplicate policy can only be changed before the import is processed.

Send the ETag returned by the retrieve operation in the If-Match header to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

import_id*string

Public ID of the import, prefixed with imp_.

Header Parameters

Idempotency-Key?string

Client-generated key that makes the request safe to retry. Must be 1 to 128 characters from [A-Za-z0-9._:-]. Optional on this operation; when sent, a malformed key returns idempotency_key_invalid, and repeating the request with the same key and the same body returns the stored result with Idempotent-Replayed: true.

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/imports/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "data": {    "created_at": "2019-08-24T14:15:22Z",    "current_operation_id": "string",    "deleted": true,    "duplicate_policy": "skip",    "failure_reason": "string",    "file_id": "string",    "id": "string",    "mapping": {      "email": "string",      "product_external_id": "string",      "status": "string"    },    "object": "import",    "revision": "string",    "rows": {      "ignored": 0,      "not_ready": 0,      "ready": 0,      "total": 0    },    "status": "pending",    "type": "students_access",    "updated_at": "2019-08-24T14:15:22Z"  }}

Retrieve an import GET

Retrieves an import by its public ID, including imports in the trash, which are returned with `deleted` set to `true`. File-level errors, such as an unreadable spreadsheet or a missing required column, are reported in `failure_reason`. The response includes an `ETag` representing the current revision. Send this value in the `If-Match` header when updating the import to avoid overwriting a newer version.

Delete an import DELETE

Moves the import to the trash. Only imports that have not been processed can be deleted. Deleting an import does not undo its effects: rows already queued for processing continue, and enrollments already granted remain in place.