Sign in

v3

latestOpenAPI 3.1.02026-07-311255771.3 MB
Unified LMS API

Complete course

Mark a course revision as completed for a user.

<Note> This endpoint requires the permission **Create and manage course progressions** to be enabled in [your scope config](/scopes). </Note>

Example Request Body

{
  "completed_at": "2024-04-15",
  "score": 93
}
post/lms/course-progressions/{course_progression_id}/complete

Path parameters

course_progression_idstring required

The ID of the course progression in Kombo or its ID in the remote system by prefixing it with remote: (e.g., remote:12312)

The ID of the course progression in Kombo or its ID in the remote system by prefixing it with remote: (e.g., remote:12312)

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

completed_atstring date-time nullable

Date when the user completed the course revision. Defaults to the current date if not provided.

scoreinteger nullable

Score the user achieved for the course, as an integer between 0 and 100 (inclusive).

Response

POST /lms/course-progressions/:course_progression_id/complete Positive response

status'success' required

Example response

{
  "data": {
    "id": "26vafvWSRmbhNcxJYqjCzuJg",
    "remote_id": "progress-12345",
    "user_id": "7xPdr68N8kG9EzLwjsN9xyz",
    "course_revision_id": "3KMdr68N8kG9EzLwjsN9aoz",
    "status": "COMPLETED",
    "enrolled_at": "2022-08-07T14:01:29.196Z",
    "completed_at": "2022-08-07T14:01:29.196Z",
    "changed_at": "2022-08-07T14:01:29.196Z",
    "remote_deleted_at": null,
    "remote_data": null,
    "user": {
      "id": "26vafvWSRmbhNcxJYqjCzuJg",
      "remote_id": "32",
      "first_name": "Sarah",
      "last_name": "Johnson",
      "work_email": "sarah.johnson@example.com"
    },
    "course_revision": {
      "id": "3KMdr68N8kG9EzLwjsN9aoz",
      "remote_id": "revision-12345",
      "title": "Building LMS integrations with Kombo",
      "course": {
        "id": "26vafvWSRmbhNcxJYqjCzuJg",
        "remote_id": "32"
      }
    }
  }
}