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": "[email protected]"
    },
    "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!"
    }
  ]
}

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": "[email protected]"
    },
    "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!"
    }
  ]
}

Supported integrations

This feature is currently available for the following integrations:

Kombo Sandbox

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

Show child attributes

data.id

string

required

The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.

data.remote_id

string

required

The raw ID of the object in the remote system. We don't recommend using this as a primary key on your side as it might sometimes be compromised of multiple identifiers if a system doesn't provide a clear primary key.

data.user_id

string

required

The Kombo ID of the user this progression relates to. The ID can be used to retrieve the user from the get users endpoint.

data.course_revision_id

string

required

The Kombo ID of the revision this progression relates to. The ID can be used to retrieve the revision from the get courses endpoint.

data.status

enum<string> | null

required

Current status of the learner in this course revision.

Available options:

ENROLLED,

IN_PROGRESS,

COMPLETED,

DROPPED

data.enrolled_at

string<date-time> | null

required

Date when the user enrolled in the course revision.

data.completed_at

string<date-time> | null

required

Date when the user completed the course revision.

data.changed_at

string<date-time>

required

The timestamp when this specific record was last modified. This field only updates when properties directly on this record change, NOT when related or nested models change. For filtering that considers nested data changes, use the updated_after parameter which will return records when either the record itself OR its related models have been updated.

data.remote_deleted_at

string<date-time> | null

required

The date and time the object was deleted in the remote system. Objects are automatically marked as deleted when Kombo can't retrieve them from the remote system anymore. Kombo will also anonymize entries 14 days after they disappear.

data.remote_data

object

required

Includes the data fetched from the remote system. Please be aware that including this in you scope config might violate other scopes that are set.

Remote data always has the endpoint path that we got the data from as the top level key. For example, it could look like: { "/companies": { ... }}

This is not available on all plans. Reach out to Kombo if you need it.

data.user

object

required

Show child attributes

data.user.id

string

required

The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.

data.user.remote_id

string

required

data.user.first_name

string | null

required

The user's first name.

data.user.last_name

string | null

required

The user's last name.

data.user.work_email

string | null

required

The user's work email address.

data.course_revision

object

required

Show child attributes

data.course_revision.id

string

required

The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.

data.course_revision.remote_id

string

required

data.course_revision.title

string | null

required

The title of the course revision.

data.course_revision.course

object

required

Show child attributes

data.course_revision.course.id

string

required

The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing.

data.course_revision.course.remote_id

string

required

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.

Show child attributes

warnings.message

string

required

Get course progressions Complete course

⌘I

General

Features

Guides

LMS API Reference

General API Reference

Enroll user in course

Example Request Body

Authorizations

Headers

Body

Response

General

Features

Guides

LMS API Reference

General API Reference

​Example Request Body

Authorizations

Headers

Body

Response

Example Request Body