Sign in

v3

OpenAPI 3.1.02026-07-311255771.3 MB
Unified LMS API

Enroll user in course

Enroll a user in a course revision.

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

Example Request Body

{
  "user_id": "7xPdr68N8kG9EzLwjsN9xyz",
  "course_revision_id": "3KMdr68N8kG9EzLwjsN9aoz"
}
post/lms/course-progressions

Headers

X-Integration-Idstring required

ID of the integration you want to interact with.

Request body

user_idstring required

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

course_revision_idstring required

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

Response

POST /lms/course-progressions 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"
      }
    }
  }
}