Sign in

v3

OpenAPI 3.1.02026-07-311255771.3 MB
Unified LMS API

Deactivate course

Deactivate a course in the LMS.

Deactivates a course, making it unavailable for new enrollments while preserving existing progress records.

<Note> This endpoint requires the permission **Upsert courses** to be enabled in [your scope config](/scopes). </Note>
post/lms/courses/{course_id}/deactivate

Path parameters

course_idstring required

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

The ID of the course 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

PostLmsCoursesCourseIdDeactivateRequestBody required

Response

POST /lms/courses/:course_id/deactivate Positive response

status'success' required

Example response

{
  "data": {
    "id": "26vafvWSRmbhNcxJYqjCzuJg",
    "remote_id": "32",
    "provider_id": "7xPdr68N8kG9EzLwjsN9xyz",
    "origin_id": "course-123",
    "remote_created_at": "2022-08-07T14:01:29.196Z",
    "remote_deleted_at": null,
    "changed_at": "2022-08-07T14:01:29.196Z",
    "remote_data": null,
    "custom_fields": null,
    "integration_fields": [],
    "provider": {
      "id": "7xPdr68N8kG9EzLwjsN9xyz",
      "remote_id": "provider-12345",
      "name": "Kombo Academy"
    },
    "revisions": [
      {
        "id": "3KMdr68N8kG9EzLwjsN9aoz",
        "remote_id": "revision-12345",
        "course_id": "26vafvWSRmbhNcxJYqjCzuJg",
        "title": "Building LMS integrations with Kombo",
        "description": "Learn how to build and integrate Learning Management System (LMS) integrations with Kombo. This course covers the unified LMS API, course management, user enrollment, progress tracking, and best practices for building robust LMS connectors.",
        "remote_url": "https://learning.acme.com/courses/building-integrations/v1",
        "status": "ACTIVE",
        "remote_created_at": "2022-08-07T14:01:29.196Z",
        "remote_deleted_at": null,
        "changed_at": "2022-08-07T14:01:29.196Z",
        "remote_data": null,
        "custom_fields": null,
        "integration_fields": [],
        "skill_assignments": [
          {
            "skill": {
              "id": "4EeSSSd9Fr8iiW9mPKmjEVWK",
              "remote_id": "skill-123",
              "name": "LMS Integration"
            }
          }
        ]
      }
    ]
  }
}