Create a processing attempt
/imports/{import_id}/processing-attemptsQueues the rows that are ready for processing. Requires the imports.process permission.
A successful response confirms that the rows were queued, not that enrollments were granted. Rows are processed asynchronously; use the list import rows operation to follow the result of each row.
The import must have a completed analysis with no errors. Use mode=initial (default) for the first attempt, and mode=retry to requeue only the rows whose processing failed.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Header Parameters
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.
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.
length <= 64Request 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
curl -X POST "https://example.com/imports/string/processing-attempts" \ -H "Idempotency-Key: string" \ -H "Content-Type: application/json" \ -d '{}'{ "data": { "created_at": "2019-08-24T14:15:22Z", "effects": { "communication_sent": true, "stage_confirmed": true }, "error": {}, "event_id": "string", "id": "string", "import_id": "string", "membership_id": "string", "object": "processing_attempt", "operation_id": "string", "requested_by": { "id": "string", "kind": "credential" }, "selection": { "mode": "initial", "rows": 0 }, "status": "queued" }}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.
Retrieve a processing attempt GET
Retrieves a processing attempt of the specified import. An attempt that belongs to a different import returns `404 Not Found`. If the attempt failed, `error` explains why the rows could not be queued. Errors for individual rows are reported by the list import rows operation.