Check the status of one API bulk import using the batchId returned by POST /import/bulk_import. Imports run in the background, so call this after submitting one to confirm it completed: an import is only finished when status is completed, and a successful response to the import request alone does not mean the contacts were created. If the import has not finished yet, wait and poll again rather than resubmitting the same contacts. success lists the ids of the contacts that were created or updated; failure lists the email of each row that was not imported, with no reason. To get failure reasons, register a callback with detailed_results when submitting the import. This endpoint knows nothing about imports started from the app or by integrations; use GET /import/history for those. Requires the contact import permission.
This endpoint returns a specific bulk import's status including the contact IDs of any newly created contacts, and emails of any contacts that failed to be created.
Add a short delay between creating a bulk import and calling for it's statusIf this endpoint is called immediately (less than a second) after a bulk import call, the
statusin the return may befalse(a boolean), because the system has not yet set a status on the batch.
{
"status":"completed",
"success":["123","124","125","126"],
"failure":[
"invalid.email@invalidDomain",
"invalid'[email protected]"
]
}The status field may contain the following values:
Status | Description |
|---|---|
waiting | The import has been received but has not received a uuid and processing has not begun. |
claimed | The import batch has received a uuid but processing has not begun. |
active | The import batch is currently being processed. |
completed | The import batch has completed processing. |
failed | The import batch has failed and can no longer be retried. |
interrupted | The import batch was interrupted due to failures and will not be retried. |