Retrieve an import
/imports/{import_id}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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/imports/string"{ "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" }}Create an import POST
Creates a user import from a spreadsheet that was previously uploaded with `purpose=import`. Creating an import does not process any rows. Request an analysis next, then start a processing attempt once the analysis is complete. If imports are disabled for the current account, the request is rejected with the `feature_disabled` error code.
Update an import PATCH
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.