Developers
Imports10

Analyze an import

POST/imports/{import_id}/analyses

Starts an asynchronous analysis of the import spreadsheet and returns the operation that tracks it. The Location header points to that operation.

Requires the imports.analyze permission. An import can be analyzed again before it is processed; the new analysis replaces the previous one.

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._:-]. Required by this operation: a missing key returns idempotency_key_required, and a malformed key returns idempotency_key_invalid. 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

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/imports/string/analyses" \  -H "Idempotency-Key: string"
{  "data": {    "attempt": {      "number": 0,      "status": "running"    },    "cancellation_requested": true,    "created_at": "2019-08-24T14:15:22Z",    "error": {      "code": "worker_error",      "field": "string",      "message": "string",      "reason": "string",      "resource_id": "string"    },    "expires_at": "2019-08-24T14:15:22Z",    "finished_at": "2019-08-24T14:15:22Z",    "id": "string",    "items_url": "string",    "object": "operation",    "progress": {      "done": 0,      "failed": 0,      "total": 0    },    "result_url": "string",    "started_at": "2019-08-24T14:15:22Z",    "status": "queued",    "type": "string"  }}

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.

List processing attempts GET

Returns the processing attempts requested through the API for the specified import. Processing started outside the API does not appear in this list.