Skip to main content
PATCH
Update course lesson
Required permissions:
  • courses:update

Autorisations

Authorization
string
header
requis

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

courses:update

Paramètres de chemin

id
string
requis

The unique identifier of the lesson to update (e.g., "les_XXXXX").

Exemple:

"lesn_xxxxxxxxxxxxx"

Corps

application/json

Parameters for UpdateLesson

assessment_completion_requirement
object | null

The passing criteria for quiz or knowledge check lessons, such as minimum grade or correct answers.

assessment_questions
object[] | null

The full list of assessment questions for quiz or knowledge check lessons. Replaces all existing questions.

attachments
FileInputWithId · object[] | null

File attachments for the lesson such as PDFs or documents. Replaces all existing attachments.

content
string | null

The Markdown content body of the lesson.

days_from_course_start_until_unlock
integer | null

The number of days after a student starts the course before this lesson becomes accessible.

Exemple:

42

embed_id
string | null

The external video identifier for embedded content (e.g., a YouTube video ID or Loom share ID).

embed_type
enum<string> | null

The type of video embed for this lesson, such as YouTube or Loom.

Options disponibles:
youtube,
loom
lesson_type
enum<string> | null

The content type of the lesson, such as video, text, quiz, or knowledge check.

Options disponibles:
text,
video,
pdf,
multi,
quiz,
knowledge_check
main_pdf
FileInputWithId · object | null

The primary PDF document attached to this lesson for student reference.

max_attempts
integer | null

The maximum number of attempts a student is allowed for assessment lessons.

Exemple:

42

mux_asset_id
string | null

The identifier of a Mux video asset to attach to this lesson (e.g., "mux_XXXXX").

Exemple:

"mux_xxxxxxxxxxxxxx"

thumbnail
FileInputWithId · object | null

The thumbnail image for the lesson in PNG, JPEG, or GIF format.

title
string | null

The display title of the lesson (e.g., "Getting Started with APIs").

visibility
enum<string> | null

Controls whether this lesson is visible to students or hidden as a draft.

Options disponibles:
visible,
hidden

Réponse

A successful response

An individual learning unit within a chapter, which can contain text, video, PDF, or assessment content.

assessment_questions
object[]
requis

The list of questions for quiz or knowledge check lessons. Empty for non-assessment lesson types.

attachments
object[]
requis

All supplementary files attached to this lesson returned as a flat array rather than a paginated connection.

content
string | null
requis

The Markdown content body of the lesson. Null if the lesson has no text content.

Exemple:

"In this lesson, we will cover the basics of technical analysis..."

created_at
string<date-time>
requis

The datetime the lesson was created.

Exemple:

"2023-12-01T05:00:00.401Z"

days_from_course_start_until_unlock
integer | null
requis

The number of days after a student starts the course before this lesson becomes accessible. Null if the lesson is available immediately.

Exemple:

42

embed_id
string | null
requis

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.

Exemple:

"dQw4w9WgXcQ"

embed_type
enum<string> | null
requis

The platform type for the embedded video. One of: youtube, loom. Null if the lesson has no embed.

Options disponibles:
youtube,
loom
id
string
requis

The unique identifier for the lesson.

Exemple:

"lesn_xxxxxxxxxxxxx"

lesson_type
enum<string>
requis

The content format of this lesson. One of: text, video, pdf, multi, quiz, knowledge_check.

Options disponibles:
text,
video,
pdf,
multi,
quiz,
knowledge_check
main_pdf
object | null
requis

The primary PDF document for PDF-type lessons. Null if this lesson is not a PDF lesson or no PDF has been uploaded.

order
integer
requis

The sort position of this lesson within its parent chapter, starting from zero.

Exemple:

42

thumbnail
object | null
requis

The thumbnail image displayed on lesson cards and previews. Null if no thumbnail has been uploaded.

title
string
requis

The display name of the lesson shown to students. Maximum 120 characters.

Exemple:

"Understanding Candlestick Patterns"

video_asset
object | null
requis

The Mux video asset for video-type lessons, used for streaming playback. Null if this lesson has no hosted video.

visibility
enum<string>
requis

The visibility setting that controls whether this lesson appears to students. One of: visible, hidden.

Options disponibles:
visible,
hidden