Create an import
/importsCreates 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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
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
curl -X POST "https://example.com/imports" \ -H "Content-Type: application/json" \ -d '{ "file_id": "string", "type": "students_access" }'{ "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" }}List imports GET
Returns user imports created from spreadsheets, using cursor-based pagination. Imports in the trash are excluded by default. Set `deleted=true` to list them. The `rows` summary of each import reflects its analysis. To follow the processing state of individual rows, use the list import rows operation.
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.