Update course lesson

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const lesson = await client.courseLessons.update('lesn_xxxxxxxxxxxxx');

console.log(lesson.id);

curl --request PATCH \
  --url https://api.whop.com/api/v1/course_lessons/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assessment_completion_requirement": {
    "minimum_grade_percent": 6.9,
    "minimum_questions_correct": 42
  },
  "assessment_questions": [
    {
      "correct_answer": "<string>",
      "question_text": "<string>",
      "id": "<string>",
      "image": {
        "id": "<string>"
      },
      "options": [
        {
          "is_correct": true,
          "option_text": "<string>",
          "id": "<string>"
        }
      ]
    }
  ],
  "attachments": [
    {
      "id": "<string>"
    }
  ],
  "content": "<string>",
  "days_from_course_start_until_unlock": 42,
  "embed_id": "<string>",
  "main_pdf": {
    "id": "<string>"
  },
  "max_attempts": 42,
  "mux_asset_id": "mux_xxxxxxxxxxxxxx",
  "thumbnail": {
    "id": "<string>"
  },
  "title": "<string>"
}
'

import requests

url = "https://api.whop.com/api/v1/course_lessons/{id}"

payload = {
    "assessment_completion_requirement": {
        "minimum_grade_percent": 6.9,
        "minimum_questions_correct": 42
    },
    "assessment_questions": [
        {
            "correct_answer": "<string>",
            "question_text": "<string>",
            "id": "<string>",
            "image": { "id": "<string>" },
            "options": [
                {
                    "is_correct": True,
                    "option_text": "<string>",
                    "id": "<string>"
                }
            ]
        }
    ],
    "attachments": [{ "id": "<string>" }],
    "content": "<string>",
    "days_from_course_start_until_unlock": 42,
    "embed_id": "<string>",
    "main_pdf": { "id": "<string>" },
    "max_attempts": 42,
    "mux_asset_id": "mux_xxxxxxxxxxxxxx",
    "thumbnail": { "id": "<string>" },
    "title": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/course_lessons/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'assessment_completion_requirement' => [
        'minimum_grade_percent' => 6.9,
        'minimum_questions_correct' => 42
    ],
    'assessment_questions' => [
        [
                'correct_answer' => '<string>',
                'question_text' => '<string>',
                'id' => '<string>',
                'image' => [
                                'id' => '<string>'
                ],
                'options' => [
                                [
                                                                'is_correct' => true,
                                                                'option_text' => '<string>',
                                                                'id' => '<string>'
                                ]
                ]
        ]
    ],
    'attachments' => [
        [
                'id' => '<string>'
        ]
    ],
    'content' => '<string>',
    'days_from_course_start_until_unlock' => 42,
    'embed_id' => '<string>',
    'main_pdf' => [
        'id' => '<string>'
    ],
    'max_attempts' => 42,
    'mux_asset_id' => 'mux_xxxxxxxxxxxxxx',
    'thumbnail' => [
        'id' => '<string>'
    ],
    'title' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/course_lessons/{id}"

	payload := strings.NewReader("{\n  \"assessment_completion_requirement\": {\n    \"minimum_grade_percent\": 6.9,\n    \"minimum_questions_correct\": 42\n  },\n  \"assessment_questions\": [\n    {\n      \"correct_answer\": \"<string>\",\n      \"question_text\": \"<string>\",\n      \"id\": \"<string>\",\n      \"image\": {\n        \"id\": \"<string>\"\n      },\n      \"options\": [\n        {\n          \"is_correct\": true,\n          \"option_text\": \"<string>\",\n          \"id\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"content\": \"<string>\",\n  \"days_from_course_start_until_unlock\": 42,\n  \"embed_id\": \"<string>\",\n  \"main_pdf\": {\n    \"id\": \"<string>\"\n  },\n  \"max_attempts\": 42,\n  \"mux_asset_id\": \"mux_xxxxxxxxxxxxxx\",\n  \"thumbnail\": {\n    \"id\": \"<string>\"\n  },\n  \"title\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.whop.com/api/v1/course_lessons/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assessment_completion_requirement\": {\n    \"minimum_grade_percent\": 6.9,\n    \"minimum_questions_correct\": 42\n  },\n  \"assessment_questions\": [\n    {\n      \"correct_answer\": \"<string>\",\n      \"question_text\": \"<string>\",\n      \"id\": \"<string>\",\n      \"image\": {\n        \"id\": \"<string>\"\n      },\n      \"options\": [\n        {\n          \"is_correct\": true,\n          \"option_text\": \"<string>\",\n          \"id\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"content\": \"<string>\",\n  \"days_from_course_start_until_unlock\": 42,\n  \"embed_id\": \"<string>\",\n  \"main_pdf\": {\n    \"id\": \"<string>\"\n  },\n  \"max_attempts\": 42,\n  \"mux_asset_id\": \"mux_xxxxxxxxxxxxxx\",\n  \"thumbnail\": {\n    \"id\": \"<string>\"\n  },\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/course_lessons/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assessment_completion_requirement\": {\n    \"minimum_grade_percent\": 6.9,\n    \"minimum_questions_correct\": 42\n  },\n  \"assessment_questions\": [\n    {\n      \"correct_answer\": \"<string>\",\n      \"question_text\": \"<string>\",\n      \"id\": \"<string>\",\n      \"image\": {\n        \"id\": \"<string>\"\n      },\n      \"options\": [\n        {\n          \"is_correct\": true,\n          \"option_text\": \"<string>\",\n          \"id\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"content\": \"<string>\",\n  \"days_from_course_start_until_unlock\": 42,\n  \"embed_id\": \"<string>\",\n  \"main_pdf\": {\n    \"id\": \"<string>\"\n  },\n  \"max_attempts\": 42,\n  \"mux_asset_id\": \"mux_xxxxxxxxxxxxxx\",\n  \"thumbnail\": {\n    \"id\": \"<string>\"\n  },\n  \"title\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "assessment_questions": [
    {
      "correct_answer": "<string>",
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "crsaq_xxxxxxxxxxxx",
      "image": {
        "content_type": "image/jpeg",
        "filename": "document.pdf",
        "id": "<string>",
        "url": "https://media.whop.com/abc123/optimized.jpg"
      },
      "options": [
        {
          "id": "crsaqo_xxxxxxxxxxx",
          "is_correct": true,
          "option_text": "<string>",
          "order": 42
        }
      ],
      "order": 42,
      "question_text": "<string>"
    }
  ],
  "attachments": [
    {
      "content_type": "image/jpeg",
      "filename": "document.pdf",
      "id": "<string>",
      "url": "https://media.whop.com/abc123/optimized.jpg"
    }
  ],
  "content": "In this lesson, we will cover the basics of technical analysis...",
  "created_at": "2023-12-01T05:00:00.401Z",
  "days_from_course_start_until_unlock": 42,
  "embed_id": "dQw4w9WgXcQ",
  "id": "lesn_xxxxxxxxxxxxx",
  "main_pdf": {
    "content_type": "image/jpeg",
    "filename": "document.pdf",
    "id": "<string>",
    "url": "https://media.whop.com/abc123/optimized.jpg"
  },
  "order": 42,
  "thumbnail": {
    "url": "https://media.whop.com/abc123/optimized.jpg"
  },
  "title": "Understanding Candlestick Patterns",
  "video_asset": {
    "asset_id": "<string>",
    "audio_only": true,
    "created_at": "2023-12-01T05:00:00.401Z",
    "duration_seconds": 42,
    "finished_uploading_at": "2023-12-01T05:00:00.401Z",
    "id": "mux_xxxxxxxxxxxxxx",
    "playback_id": "<string>",
    "signed_playback_id": "<string>",
    "signed_storyboard_playback_token": "<string>",
    "signed_thumbnail_playback_token": "<string>",
    "signed_video_playback_token": "<string>",
    "updated_at": "2023-12-01T05:00:00.401Z"
  }
}

{
  "error": {
    "code": "parameter_missing",
    "message": "Missing required parameter: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "Invalid or missing API key",
    "type": "unauthorized"
  }
}

{
  "error": {
    "message": "You do not have permission to access this resource",
    "type": "forbidden"
  }
}

{
  "error": {
    "message": "Resource not found",
    "type": "not_found"
  }
}

{
  "error": null
}

{
  "error": null
}

{
  "error": {
    "message": "An unexpected error occurred",
    "type": "internal_server_error"
  }
}

PATCH

course_lessons

{id}

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const lesson = await client.courseLessons.update('lesn_xxxxxxxxxxxxx');

console.log(lesson.id);

curl --request PATCH \
  --url https://api.whop.com/api/v1/course_lessons/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assessment_completion_requirement": {
    "minimum_grade_percent": 6.9,
    "minimum_questions_correct": 42
  },
  "assessment_questions": [
    {
      "correct_answer": "<string>",
      "question_text": "<string>",
      "id": "<string>",
      "image": {
        "id": "<string>"
      },
      "options": [
        {
          "is_correct": true,
          "option_text": "<string>",
          "id": "<string>"
        }
      ]
    }
  ],
  "attachments": [
    {
      "id": "<string>"
    }
  ],
  "content": "<string>",
  "days_from_course_start_until_unlock": 42,
  "embed_id": "<string>",
  "main_pdf": {
    "id": "<string>"
  },
  "max_attempts": 42,
  "mux_asset_id": "mux_xxxxxxxxxxxxxx",
  "thumbnail": {
    "id": "<string>"
  },
  "title": "<string>"
}
'

import requests

url = "https://api.whop.com/api/v1/course_lessons/{id}"

payload = {
    "assessment_completion_requirement": {
        "minimum_grade_percent": 6.9,
        "minimum_questions_correct": 42
    },
    "assessment_questions": [
        {
            "correct_answer": "<string>",
            "question_text": "<string>",
            "id": "<string>",
            "image": { "id": "<string>" },
            "options": [
                {
                    "is_correct": True,
                    "option_text": "<string>",
                    "id": "<string>"
                }
            ]
        }
    ],
    "attachments": [{ "id": "<string>" }],
    "content": "<string>",
    "days_from_course_start_until_unlock": 42,
    "embed_id": "<string>",
    "main_pdf": { "id": "<string>" },
    "max_attempts": 42,
    "mux_asset_id": "mux_xxxxxxxxxxxxxx",
    "thumbnail": { "id": "<string>" },
    "title": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/course_lessons/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'assessment_completion_requirement' => [
        'minimum_grade_percent' => 6.9,
        'minimum_questions_correct' => 42
    ],
    'assessment_questions' => [
        [
                'correct_answer' => '<string>',
                'question_text' => '<string>',
                'id' => '<string>',
                'image' => [
                                'id' => '<string>'
                ],
                'options' => [
                                [
                                                                'is_correct' => true,
                                                                'option_text' => '<string>',
                                                                'id' => '<string>'
                                ]
                ]
        ]
    ],
    'attachments' => [
        [
                'id' => '<string>'
        ]
    ],
    'content' => '<string>',
    'days_from_course_start_until_unlock' => 42,
    'embed_id' => '<string>',
    'main_pdf' => [
        'id' => '<string>'
    ],
    'max_attempts' => 42,
    'mux_asset_id' => 'mux_xxxxxxxxxxxxxx',
    'thumbnail' => [
        'id' => '<string>'
    ],
    'title' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/course_lessons/{id}"

	payload := strings.NewReader("{\n  \"assessment_completion_requirement\": {\n    \"minimum_grade_percent\": 6.9,\n    \"minimum_questions_correct\": 42\n  },\n  \"assessment_questions\": [\n    {\n      \"correct_answer\": \"<string>\",\n      \"question_text\": \"<string>\",\n      \"id\": \"<string>\",\n      \"image\": {\n        \"id\": \"<string>\"\n      },\n      \"options\": [\n        {\n          \"is_correct\": true,\n          \"option_text\": \"<string>\",\n          \"id\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"content\": \"<string>\",\n  \"days_from_course_start_until_unlock\": 42,\n  \"embed_id\": \"<string>\",\n  \"main_pdf\": {\n    \"id\": \"<string>\"\n  },\n  \"max_attempts\": 42,\n  \"mux_asset_id\": \"mux_xxxxxxxxxxxxxx\",\n  \"thumbnail\": {\n    \"id\": \"<string>\"\n  },\n  \"title\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.patch("https://api.whop.com/api/v1/course_lessons/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"assessment_completion_requirement\": {\n    \"minimum_grade_percent\": 6.9,\n    \"minimum_questions_correct\": 42\n  },\n  \"assessment_questions\": [\n    {\n      \"correct_answer\": \"<string>\",\n      \"question_text\": \"<string>\",\n      \"id\": \"<string>\",\n      \"image\": {\n        \"id\": \"<string>\"\n      },\n      \"options\": [\n        {\n          \"is_correct\": true,\n          \"option_text\": \"<string>\",\n          \"id\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"content\": \"<string>\",\n  \"days_from_course_start_until_unlock\": 42,\n  \"embed_id\": \"<string>\",\n  \"main_pdf\": {\n    \"id\": \"<string>\"\n  },\n  \"max_attempts\": 42,\n  \"mux_asset_id\": \"mux_xxxxxxxxxxxxxx\",\n  \"thumbnail\": {\n    \"id\": \"<string>\"\n  },\n  \"title\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/course_lessons/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"assessment_completion_requirement\": {\n    \"minimum_grade_percent\": 6.9,\n    \"minimum_questions_correct\": 42\n  },\n  \"assessment_questions\": [\n    {\n      \"correct_answer\": \"<string>\",\n      \"question_text\": \"<string>\",\n      \"id\": \"<string>\",\n      \"image\": {\n        \"id\": \"<string>\"\n      },\n      \"options\": [\n        {\n          \"is_correct\": true,\n          \"option_text\": \"<string>\",\n          \"id\": \"<string>\"\n        }\n      ]\n    }\n  ],\n  \"attachments\": [\n    {\n      \"id\": \"<string>\"\n    }\n  ],\n  \"content\": \"<string>\",\n  \"days_from_course_start_until_unlock\": 42,\n  \"embed_id\": \"<string>\",\n  \"main_pdf\": {\n    \"id\": \"<string>\"\n  },\n  \"max_attempts\": 42,\n  \"mux_asset_id\": \"mux_xxxxxxxxxxxxxx\",\n  \"thumbnail\": {\n    \"id\": \"<string>\"\n  },\n  \"title\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "assessment_questions": [
    {
      "correct_answer": "<string>",
      "created_at": "2023-12-01T05:00:00.401Z",
      "id": "crsaq_xxxxxxxxxxxx",
      "image": {
        "content_type": "image/jpeg",
        "filename": "document.pdf",
        "id": "<string>",
        "url": "https://media.whop.com/abc123/optimized.jpg"
      },
      "options": [
        {
          "id": "crsaqo_xxxxxxxxxxx",
          "is_correct": true,
          "option_text": "<string>",
          "order": 42
        }
      ],
      "order": 42,
      "question_text": "<string>"
    }
  ],
  "attachments": [
    {
      "content_type": "image/jpeg",
      "filename": "document.pdf",
      "id": "<string>",
      "url": "https://media.whop.com/abc123/optimized.jpg"
    }
  ],
  "content": "In this lesson, we will cover the basics of technical analysis...",
  "created_at": "2023-12-01T05:00:00.401Z",
  "days_from_course_start_until_unlock": 42,
  "embed_id": "dQw4w9WgXcQ",
  "id": "lesn_xxxxxxxxxxxxx",
  "main_pdf": {
    "content_type": "image/jpeg",
    "filename": "document.pdf",
    "id": "<string>",
    "url": "https://media.whop.com/abc123/optimized.jpg"
  },
  "order": 42,
  "thumbnail": {
    "url": "https://media.whop.com/abc123/optimized.jpg"
  },
  "title": "Understanding Candlestick Patterns",
  "video_asset": {
    "asset_id": "<string>",
    "audio_only": true,
    "created_at": "2023-12-01T05:00:00.401Z",
    "duration_seconds": 42,
    "finished_uploading_at": "2023-12-01T05:00:00.401Z",
    "id": "mux_xxxxxxxxxxxxxx",
    "playback_id": "<string>",
    "signed_playback_id": "<string>",
    "signed_storyboard_playback_token": "<string>",
    "signed_thumbnail_playback_token": "<string>",
    "signed_video_playback_token": "<string>",
    "updated_at": "2023-12-01T05:00:00.401Z"
  }
}

{
  "error": {
    "code": "parameter_missing",
    "message": "Missing required parameter: amount.",
    "param": "amount",
    "type": "invalid_request_error"
  }
}

{
  "error": {
    "message": "Invalid or missing API key",
    "type": "unauthorized"
  }
}

{
  "error": {
    "message": "You do not have permission to access this resource",
    "type": "forbidden"
  }
}

{
  "error": {
    "message": "Resource not found",
    "type": "not_found"
  }
}

{
  "error": null
}

{
  "error": null
}

{
  "error": {
    "message": "An unexpected error occurred",
    "type": "internal_server_error"
  }
}

Authorizations

Authorization

string

header

required

A 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 ***************************

Path Parameters

string

required

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

Example:

"lesn_xxxxxxxxxxxxx"

Body

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.

Show child attributes

assessment_questions

object[] | null

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

Show child attributes

attachments

FileInputWithId · object[] | null

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

Show child attributes

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.

Example:

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.

Available options:

youtube,

loom

lesson_type

enum<string> | null

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

Available options:

text,

video,

pdf,

multi,

quiz,

knowledge_check

main_pdf

FileInputWithId · object | null

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

Show child attributes

max_attempts

integer | null

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

Example:

42

mux_asset_id

string | null

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

Example:

"mux_xxxxxxxxxxxxxx"

thumbnail

FileInputWithId · object | null

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

Show child attributes

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.

Available options:

visible,

hidden

Response

A successful response

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

assessment_questions

object[]

required

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

Show child attributes

attachments

object[]

required

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

Show child attributes

content

string | null

required

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

Example:

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

created_at

string<date-time>

required

The datetime the lesson was created.

Example:

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

days_from_course_start_until_unlock

integer | null

required

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

Example:

42

embed_id

string | null

required

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.

Example:

"dQw4w9WgXcQ"

embed_type

enum<string> | null

required

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

Available options:

youtube,

loom

string

required

The unique identifier for the lesson.

Example:

"lesn_xxxxxxxxxxxxx"

lesson_type

enum<string>

required

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

Available options:

text,

video,

pdf,

multi,

quiz,

knowledge_check

main_pdf

object | null

required

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

Show child attributes

order

integer

required

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

Example:

42

thumbnail

object | null

required

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

Show child attributes

title

string

required

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

Example:

"Understanding Candlestick Patterns"

video_asset

object | null

required

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

Show child attributes

visibility

enum<string>

required

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

Available options:

visible,

hidden

Retrieve course lesson

Mark as completed course lesson

⌘I

Introduction

Developer

Ads

CRM

AI

Identity

Bounties

Cards

Engagement

Payins

Courses

Payouts

Stats

Update course lesson

Authorizations

Path Parameters

Body

Response