Connect a lesson
/products/{product_id}/lessons/{lesson_id}/connectionConnects the lesson to the source lesson given by source_lesson_id. A connected lesson mirrors the content of its source lesson and takes on its format, name, summary, and thumbnail.
Requires the lessons.connect permission on the lesson being connected. The source lesson must be readable with the current credentials; otherwise the API returns 404 Not Found. The source lesson must have the same format, must not be the lesson itself, and must not be connected to another lesson.
Send the lesson's current ETag in the If-Match header to avoid overwriting a newer version. Replicated lessons are read-only, and requests to change them 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
Header 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
application/json
curl -X PUT "https://example.com/products/string/lessons/string/connection" \ -H "Content-Type: application/json" \ -d '{ "source_lesson_id": "string" }'{ "data": { "connected": true, "connected_at": "2019-08-24T14:15:22Z", "object": "lesson_connection", "source": { "lesson_id": "string", "module_id": "string", "name": "string", "product_id": "string" } }}Retrieve a lesson connection GET
Returns whether the lesson is connected to a source lesson and, if so, identifies the source lesson, its product, and its module. Lessons without a connection return `connected` set to `false`.
Disconnect a lesson DELETE
Disconnects the lesson from its source lesson, so it no longer mirrors that lesson's content. If the lesson is not connected, the request fails with `state_conflict`. Replicated lessons are read-only, and requests to change them return `replica_readonly`.