Create a lesson
/products/{product_id}/lessonsCreates a lesson in the product, optionally inside a module. New lessons are created as drafts.
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.
Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.
In: header
Path Parameters
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/products/string/lessons" \ -H "Content-Type: application/json" \ -d '{ "format": "standard", "name": "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" }}List lessons GET
Returns the lessons of a product, using cursor pagination. Lesson bodies are not included; use the content endpoint to retrieve them. The collection can be filtered by module, status, format, and name. Set `unassigned` to `true` to return only lessons that are not in a module. Trashed lessons are excluded by default; set `deleted` to `true` to return only lessons in the trash.
Retrieve a lesson GET
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.