Kombo · Schema
PostLmsCoursesCourseIdDeactivatePositiveResponse
ATSEmbedded iPaaSHRISLMSPayrollUnified API
Properties
| Name | Type | Description |
|---|---|---|
| status | string | |
| data | object | |
| warnings | array | 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. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/PostLmsCoursesCourseIdDeactivatePositiveResponse",
"title": "PostLmsCoursesCourseIdDeactivatePositiveResponse",
"type": "object",
"properties": {
"status": {
"type": "string",
"const": "success"
},
"data": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": "string",
"description": "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."
},
"provider_id": {
"type": [
"string",
"null"
],
"description": "The Kombo ID of the course provider of this course, if applicable."
},
"origin_id": {
"type": [
"string",
"null"
],
"description": "A stable identifier you provided when creating this course. Can be used to identify and update the course in subsequent requests."
},
"remote_created_at": {
"description": "The date and time the object was created in the remote system.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_deleted_at": {
"description": "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.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"changed_at": {
"description": "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.",
"type": "string",
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_data": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Includes the data fetched from the remote system.\nPlease be aware that including this in you scope config might violate other\nscopes that are set.\n\nRemote data always has the endpoint path that we got the data from as the\ntop level key. For example, it could look like: `{ \"/companies\": { ... }}`\n\nThis is not available on all plans. Reach out to Kombo if you need it."
},
"custom_fields": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "A key-value store of fields not covered by the schema. [Read more](/custom-fields)"
},
"integration_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object."
},
"key": {
"type": "string",
"description": "The key of the field in the remote system."
},
"type": {
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"description": "- `DEFAULT`: static fields in the remote system.\n- `CUSTOM`: fields that are created/editable by the user."
},
"value": {
"type": "null",
"description": "The field's value."
},
"label": {
"type": [
"string",
"null"
],
"description": "The label of the field. (not always available)"
}
},
"required": [
"id",
"key",
"type",
"label"
]
},
"description": "An array of selected passthrough integration fields. [Read more](/integration-fields)",
"examples": [
[
{
"id": "5NVFhMpB9Ah6by44tzNjZLyE",
"key": "firstName",
"type": "DEFAULT",
"value": "Frank",
"label": "First Name"
},
{
"id": "8nuajYpoRd5GnxEQaaWKUDYQ",
"key": "customTshirtSize",
"type": "CUSTOM",
"value": "XL",
"label": "T-Shirt Size"
}
]
]
},
"provider": {
"type": [
"object",
"null"
],
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": "string",
"description": "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."
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the provider."
}
},
"required": [
"id",
"remote_id",
"name"
],
"examples": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "provider-12345",
"name": "Kombo Academy"
}
]
},
"revisions": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": "string",
"description": "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."
},
"course_id": {
"type": [
"string",
"null"
],
"description": "The Kombo ID of the course this revision belongs to. The ID can be used to retrieve the course from the `get courses` endpoint."
},
"title": {
"type": [
"string",
"null"
],
"description": "The title of the course revision."
},
"description": {
"type": [
"string",
"null"
],
"description": "A description of the course revision."
},
"remote_url": {
"type": [
"string",
"null"
],
"description": "URL to the course overview page within the LMS itself."
},
"status": {
"type": [
"string",
"null"
],
"enum": [
"ACTIVE",
"INACTIVE"
],
"description": "The status of this revision (ACTIVE or INACTIVE)."
},
"remote_created_at": {
"description": "The date and time the object was created in the remote system.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_deleted_at": {
"description": "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.",
"type": [
"string",
"null"
],
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"changed_at": {
"description": "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.",
"type": "string",
"format": "date-time",
"externalDocs": {
"url": "https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString"
}
},
"remote_data": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "Includes the data fetched from the remote system.\nPlease be aware that including this in you scope config might violate other\nscopes that are set.\n\nRemote data always has the endpoint path that we got the data from as the\ntop level key. For example, it could look like: `{ \"/companies\": { ... }}`\n\nThis is not available on all plans. Reach out to Kombo if you need it."
},
"custom_fields": {
"type": [
"object",
"null"
],
"additionalProperties": true,
"description": "A key-value store of fields not covered by the schema. [Read more](/custom-fields)"
},
"integration_fields": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object."
},
"key": {
"type": "string",
"description": "The key of the field in the remote system."
},
"type": {
"type": "string",
"enum": [
"DEFAULT",
"CUSTOM"
],
"description": "- `DEFAULT`: static fields in the remote system.\n- `CUSTOM`: fields that are created/editable by the user."
},
"value": {
"type": "null",
"description": "The field's value."
},
"label": {
"type": [
"string",
"null"
],
"description": "The label of the field. (not always available)"
}
},
"required": [
"id",
"key",
"type",
"label"
]
},
"description": "An array of selected passthrough integration fields. [Read more](/integration-fields)",
"examples": [
[
{
"id": "5NVFhMpB9Ah6by44tzNjZLyE",
"key": "firstName",
"type": "DEFAULT",
"value": "Frank",
"label": "First Name"
},
{
"id": "8nuajYpoRd5GnxEQaaWKUDYQ",
"key": "customTshirtSize",
"type": "CUSTOM",
"value": "XL",
"label": "T-Shirt Size"
}
]
]
},
"skill_assignments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"skill": {
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The globally unique ID of this object generated by Kombo. We recommend using this as a stable primary key for syncing."
},
"remote_id": {
"type": [
"string",
"null"
],
"description": "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."
},
"name": {
"type": [
"string",
"null"
],
"description": "The name of the skill."
}
},
"required": [
"id",
"remote_id",
"name"
],
"examples": [
{
"id": "26vafvWSRmbhNcxJYqjCzuJg",
"remote_id": "skill-12345",
"name": "LMS Integration"
}
]
}
},
"required": [
"skill"
]
}
}
},
"required": [
"id",
"remote_id",
"course_id",
"title",
"description",
"remote_url",
"status",
"remote_created_at",
"remote_deleted_at",
"changed_at",
"remote_data",
"custom_fields",
"integration_fields",
"skill_assignments"
],
"examples": [
{
"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"
}
}
]
}
]
}
}
},
"required": [
"id",
"remote_id",
"provider_id",
"origin_id",
"remote_created_at",
"remote_deleted_at",
"changed_at",
"remote_data",
"custom_fields",
"integration_fields",
"provider",
"revisions"
],
"examples": [
{
"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"
}
}
]
}
]
}
]
},
"warnings": {
"type": "array",
"items": {
"type": "object",
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
]
},
"description": "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."
}
},
"required": [
"status",
"data",
"warnings"
]
}