Skip to main content
POST
/
lms
/
progress
Create progress
curl --request POST \
  --url https://api.kombo.dev/v1/lms/progress \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "course_id": "<string>",
  "user_id": "<string>",
  "progress_id": "<string>",
  "status": "ENROLLED",
  "enrollment_date": "<string>",
  "completion_date": "<string>",
  "score": -1.7976931348623157e+308,
  "duration": -1.7976931348623157e+308,
  "comments": "<string>"
}'
{
  "status": "success",
  "data": {
    "id": "7xPdr68N8kG9EzLwjsN9xyz",
    "remote_id": "892476",
    "course_id": "3KMdr68N8kG9EzLwjsN9aoz",
    "user_id": "26vafvWSRmbhNcxJYqjCzuJg",
    "status": "COMPLETED",
    "enrollment_date": "2024-03-01T10:00:00.000Z",
    "completion_date": "2024-04-15T16:30:00.000Z",
    "score": 92.5,
    "duration": 480,
    "comments": "Excellent performance throughout the course.",
    "changed_at": "2022-08-07T14:01:29.196Z",
    "remote_data": null
  }
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Body

application/json

POST /lms/progress Request body

​
course_id
string
required

The ID of the course.

​
user_id
string
required

The ID of the user.

​
progress_id
string
required

Unique identifier for this progress entry.

​
status
enum<string>
required

Current status of the learner in this course.

Available options:
ENROLLED,
STARTED,
COMPLETED,
STOPPED
​
enrollment_date
string
required

Date when the user enrolled in the course.

​
completion_date
string | null

Date when the user completed the course.

​
score
number | null

Numerical score achieved (e.g., 85.5).

Required range: x >= -1.7976931348623157e+308
​
duration
number | null

Total time spent on the course in minutes.

Required range: x >= -1.7976931348623157e+308
​
comments
string | null

Additional comments or notes.

Response

POST /lms/progress Positive response

​
status
string
required
Allowed value: "success"
​
data
object
required
Examples:
{
  "id": "7xPdr68N8kG9EzLwjsN9xyz",
  "remote_id": "892476",
  "course_id": "3KMdr68N8kG9EzLwjsN9aoz",
  "user_id": "26vafvWSRmbhNcxJYqjCzuJg",
  "status": "COMPLETED",
  "enrollment_date": "2024-03-01T10:00:00.000Z",
  "completion_date": "2024-04-15T16:30:00.000Z",
  "score": 92.5,
  "duration": 480,
  "comments": "Excellent performance throughout the course.",
  "changed_at": "2022-08-07T14:01:29.196Z",
  "remote_data": null
}