Developers
Lessons

Retrieve a lesson

GET/products/{product_id}/lessons/{lesson_id}

Retrieves a lesson by its public ID. The lesson body is available through the content endpoint.

The response includes an ETag representing the current revision. Send this value in the If-Match header when changing the lesson to avoid overwriting a newer version.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Path Parameters

product_id*string
lesson_id*string

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/products/string/lessons/string"
{  "data": {    "connection": {      "connected": true,      "source_lesson_id": "string",      "source_product_id": "string"    },    "created_at": "2019-08-24T14:15:22Z",    "deleted": true,    "exam_id": "string",    "format": "standard",    "id": "string",    "image": "string",    "module_id": "string",    "name": "string",    "object": "lesson",    "pinned": true,    "position": 0,    "product_id": "string",    "published_at": "2019-08-24T14:15:22Z",    "revision": "string",    "settings": null,    "status": "published",    "summary": "string",    "updated_at": "2019-08-24T14:15:22Z"  }}

Create a lesson POST

Creates a lesson in the product, optionally inside a module. New lessons are created as drafts. `position` is 1-based among the lesson's siblings; a value greater than the number of siblings places the lesson at the end. The `Location` header of the response contains the URL of the new lesson. Lessons cannot be created in replicated products; such requests return `replica_readonly`.

Update a lesson PATCH

Updates only the fields included in the request. Changing `status` requires the `lessons.publish` permission. Moving the lesson to another product with `target_product_id` requires the `lessons.update` permission on the destination product; lessons that are connected to a source lesson, or that are the source of connected lessons, cannot be moved. Setting `deleted` to `false` restores a lesson from the trash. The exam set in `exam_id` must belong to the same product. `position` is 1-based among the lesson's siblings, in the destination when the lesson is moved; a value greater than the number of siblings places the lesson at the end. A lesson moved to another module or product without `position` is placed at the end. Replicated lessons accept only `status`; any other field is rejected with `replica_readonly`. Lessons cannot be moved into replicated products. Send the lesson's current `ETag` in the `If-Match` header to avoid overwriting a newer version.