Create a new lesson within a course chapter. Lessons can contain video, text, or assessment content.
Required permissions:
courses:updateA company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Parameters for CreateLesson
The unique identifier of the chapter to create the lesson in (e.g., "chap_XXXXX").
"chap_xxxxxxxxxxxxx"
The content type of the lesson, such as video, text, quiz, or knowledge check.
text, video, pdf, multi, quiz, knowledge_check The rich text or HTML content body of the lesson.
The number of days after a student starts the course before this lesson becomes accessible.
42
The external video identifier for embedded content (e.g., a YouTube video ID or Loom share ID).
The type of video embed for this lesson, such as YouTube or Loom.
youtube, loom The thumbnail image for the lesson in PNG, JPEG, or GIF format.
The display title of the lesson (e.g., "Getting Started with APIs").
A successful response
An individual learning unit within a chapter, which can contain text, video, PDF, or assessment content.
The unique identifier for the lesson.
"lesn_xxxxxxxxxxxxx"
The display name of the lesson shown to students. Maximum 120 characters.
"Understanding Candlestick Patterns"
The sort position of this lesson within its parent chapter, starting from zero.
42
The content format of this lesson. One of: text, video, pdf, multi, quiz, knowledge_check.
text, video, pdf, multi, quiz, knowledge_check The visibility setting that controls whether this lesson appears to students. One of: visible, hidden.
visible, hidden The text body of the lesson in plain text format. Null if the lesson has no text content.
"In this lesson, we will cover the basics of technical analysis..."
The number of days after a student starts the course before this lesson becomes accessible. Null if the lesson is available immediately.
42
The platform type for the embedded video. One of: youtube, loom. Null if the lesson has no embed.
youtube, loom The external video identifier for embedded video lessons, such as a YouTube video ID or Loom share ID. Null if the lesson has no embed.
"dQw4w9WgXcQ"
The datetime the lesson was created.
"2023-12-01T05:00:00.401Z"
The thumbnail image displayed on lesson cards and previews. Null if no thumbnail has been uploaded.
The Mux video asset for video-type lessons, used for streaming playback. Null if this lesson has no hosted video.
The primary PDF document for PDF-type lessons. Null if this lesson is not a PDF lesson or no PDF has been uploaded.
The list of questions for quiz or knowledge check lessons. Empty for non-assessment lesson types.
All supplementary files attached to this lesson returned as a flat array rather than a paginated connection.