LMS Batch Sync Status

​

Overview

​

Path Parameters

• jobId — The job ID returned by the batch sync endpoint (required). Must be a valid UUID.

​

Response Format

{
  "jobId": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "totalCustomers": 3,
  "processed": 2,
  "failed": 1,
  "progressPercentage": 100.0,
  "createdAt": "2026-08-03T12:00:00Z",
  "processingStartedAt": "2026-08-03T12:00:01Z",
  "processingCompletedAt": "2026-08-03T12:00:15Z",
  "errorMessage": null
}

​

Response Fields

​

Status Values

• pending — Job is queued but background processing has not started yet
• processing — Job is actively syncing customers. Poll again to see updated progress.
• completed — All customers have been processed. Check processed and failed for results.
• failed — The job encountered a fatal error (e.g., could not read batch data) or all customers failed to sync.

​

Polling Recommendations

• Poll every 5 seconds while status is processing
• Stop polling when status is completed or failed
• The progressPercentage field provides a quick progress indicator

​

Error Handling

​

Authentication