Get Batch Upload Status

🚧

Partner Restricted

All endpoints for this API are restricted to providers that have signed a Paylocity technology partnership agreement. Interested organizations should review our partner requirements and contact guidelines.

Summary Description

Returns the status of a bulk upload operation, including overall progress, success/failure counts, and detailed status for each content item. Partners can call this endpoint at any time to monitor the progress of their bulk upload.

Use Cases

• Partner wants to check the progress of a bulk upload operation.
• Partner needs to identify which content items succeeded or failed.
• Partner wants detailed error messages for failed items.

Status Values

• Pending: Bulk upload request created, waiting for ZIP file upload
• Downloading: ZIP file is being downloaded from File Access
• Downloaded: ZIP file downloaded and extracted
• Processing: Content items are being created in LMS
• Uploading: Content files are being uploaded to LMS
• Created: All content items created successfully (before upload)
• PartialCreated: Some content items created, some failed (before upload)
• CreationFailed: All content items failed to create
• Completed: All content items successfully processed and uploaded
• PartialSuccess: Some content items succeeded, some failed
• Failed: All content items failed to process