Skip to main content
POST
/
lms
/
course-progressions
Enroll user in course
curl --request POST \
  --url https://api.kombo.dev/v1/lms/course-progressions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '
{
  "user_id": "7xPdr68N8kG9EzLwjsN9xyz",
  "course_revision_id": "3KMdr68N8kG9EzLwjsN9aoz"
}
'
{
  "status": "success",
  "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"
      }
    }
  },
  "warnings": [
    {
      "message": "This is an example warning!"
    }
  ]
}
This feature is currently available for the following integrations:You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.
This endpoint requires the permission Create and manage course progressions to be enabled in your scope config.

​
Example Request Body

{
  "user_id": "7xPdr68N8kG9EzLwjsN9xyz",
  "course_revision_id": "3KMdr68N8kG9EzLwjsN9aoz"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Body

application/json

POST /lms/course-progressions Request body

​
user_id
string
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_id
string
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
string
required
Allowed value: "success"
​
data
object
required
Example:
{
  "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"
    }
  }
}
​
warnings
object[]
required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.