ClickFunnels Courses::Lesson API

openapi: 3.2.0
info:
  title: ClickFunnels Courses::Lesson API
  termsOfService: https://www.clickfunnels.com/terms-of-service
  contact:
    name: ClickFunnels API Team
    url: https://developers.myclickfunnels.com
  x-logo:
    url: https://statics.myclickfunnels.com/image/1126065/file/31edf05760fafe41a82f16a668ab251f.png
  description: 'The ClickFunnels REST API that powers webhooks, native integrations, and Zapier lets you manage your ClickFunnels data, automate your workflows, and recreate ClickFunnels functionality in your own apps.

    '
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 2.0.0
servers:
- url: https://{subdomain}.myclickfunnels.com/api/v2
  description: ClickFunnels API
  variables:
    subdomain:
      default: myworkspace
security:
- BearerAuth: []
tags:
- name: Courses::Lesson
  description: '> Represents the material within a Course


    The lesson is the part of the course which teaches the material described within the course. Completing

    lessons can unlock access to other lessons or sections within a course. Completing lessons increases the

    course progress percent.


    See [Lessons](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#lessons) in the [Courses Skill](https://accounts.myclickfunnels.com/.well-known/courses/skill.md) for creating and updating lessons.

    '
paths:
  /courses/sections/{section_id}/lessons:
    get:
      tags:
      - Courses::Lesson
      summary: List Lessons
      description: 'List Lessons. Ordered by id ascending by default (pass sort_order=desc for

        descending), consistent with the pagination cursor, so following the

        Pagination-Next header returns every lesson exactly once.


        Pass sort_property=sort_order for the builder''s display order of lessons

        within the section (sort_order is scoped per section, starting at 0).

        '
      operationId: listCoursesLessons
      parameters:
      - name: section_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - name: sort_property
        in: query
        description: 'Sort property of a list response. The default is id and thus the created_at order.

          If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

          '
        required: false
        schema:
          type: string
          enum:
          - id
          - updated_at
          - sort_order
      responses:
        '200':
          description: OK
          headers:
            Pagination-Next:
              $ref: '#/components/headers/PaginationNext'
            Link:
              $ref: '#/components/headers/Link'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CoursesLessonAttributes'
              example:
              - id: 3
                public_id: YcBQNd
                title: Lesson 3
                body: Example Lesson
                section_id: 13
                published_at: '2025-01-01T00:00:00.000Z'
                current_path: null
                sort_order: 2
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
              - id: 4
                public_id: adKOnr
                title: Lesson 4
                body: Example Lesson
                section_id: 14
                published_at: '2025-01-01T00:00:00.000Z'
                current_path: null
                sort_order: 3
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    description: Not found - This usually happens when you try to access a record that does not exist in your account. It can also happen when the provided parent record is missing, e.g. you have put in a non-existent Workspaces parent ID.
              example:
                error: 'Not found: Record missing'
    post:
      tags:
      - Courses::Lesson
      summary: Create Lesson
      description: Add a new Lesson. The lesson body is authored in Markdown via `lesson_content`, not PML. See [Lessons](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#lessons) in the [Courses Skill](https://accounts.myclickfunnels.com/.well-known/courses/skill.md).
      operationId: createCoursesLessons
      parameters:
      - name: section_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Lesson
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                courses_lesson:
                  type: object
                  $ref: '#/components/schemas/CoursesLessonParametersUpdate'
            example:
              courses_lesson:
                title: Lesson 1
                body: Example Lesson
                lesson_content: '## Welcome

                  This is the lesson content.'
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoursesLessonAttributes'
              example:
                id: 6
                public_id: PfXVKq
                title: Lesson 6
                body: Example Lesson
                section_id: 16
                published_at: '2025-01-01T00:00:00.000Z'
                current_path: null
                sort_order: 5
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: Title can't be blank
  /courses/lessons/{id}:
    get:
      tags:
      - Courses::Lesson
      summary: Fetch Lesson
      description: Fetch Lesson
      operationId: getCoursesLessons
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoursesLessonAttributes'
              example:
                id: 5
                public_id: OfXUJp
                title: Lesson 5
                body: Example Lesson
                section_id: 15
                published_at: '2025-01-01T00:00:00.000Z'
                current_path: null
                sort_order: 4
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
    put:
      tags:
      - Courses::Lesson
      summary: Update Lesson
      description: Update Lesson. See [Permitted lesson fields](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#permitted-lesson-fields) in the [Courses Skill](https://accounts.myclickfunnels.com/.well-known/courses/skill.md); the Markdown body field is `lesson_content`.
      operationId: updateCoursesLessons
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Lesson
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                courses_lesson:
                  type: object
                  $ref: '#/components/schemas/CoursesLessonParametersUpdate'
            example:
              courses_lesson:
                title: Lesson 1
                body: Example Lesson
                lesson_content: '## Welcome

                  This is the lesson content.'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoursesLessonAttributes'
              example:
                id: 8
                public_id: mZRfdu
                title: Lesson 8
                body: Example Lesson
                section_id: 18
                published_at: '2025-01-01T00:00:00.000Z'
                current_path: null
                sort_order: 7
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Bad request: HTTP body must be valid JSON'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
  /courses/lessons/{id}/publish:
    post:
      tags:
      - Courses::Lesson
      summary: Publish Lesson
      description: 'Makes a single lesson live by setting `published_at`. Pass an optional future `published_at` to schedule it; omit it to publish now. A past `published_at` is rejected. A lesson''s `published_at` is not writable via `updateCoursesLessons`, so this is the way to publish or schedule an individual lesson.

        See [Publishing](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#publishing) in the [Courses Skill](https://accounts.myclickfunnels.com/.well-known/courses/skill.md) for the other publish paths.'
      operationId: publishCoursesLessons
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                published_at:
                  type: string
                  format: date-time
                  description: Optional ISO 8601 datetime at which the lesson should become live. Must be now or in the future — a past datetime is rejected. Omit to publish immediately.
            example:
              published_at: '2026-09-01T09:00:00.000Z'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoursesLessonAttributes'
              example:
                id: 5
                public_id: OfXUJp
                title: Lesson 5
                body: Example Lesson
                section_id: 15
                published_at: '2026-09-01T09:00:00.000Z'
                current_path: null
                sort_order: 4
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: API key missing or invalid
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: 'Not found: Record missing'
        '422':
          description: Unprocessable Entity
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
              example:
                error: published_at cannot be in the past; omit it to publish now or pass a future datetime to schedule
components:
  headers:
    PaginationNext:
      description: ID of the last item in the current response after which more records exist. You can use it in an `after` query parameter for cursor-based pagination to get to the next page.
      schema:
        type: string
    Link:
      description: A direct link to the next page for the cursor-based pagination. It includes the `after` and the Pagination-Next ID value.
      schema:
        type: string
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    sort_order:
      name: sort_order
      in: query
      description: Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples [in our guides](https://developers.myclickfunnels.com/docs/pagination).
      required: false
      schema:
        type: string
        enum:
        - asc
        - desc
    after:
      name: after
      in: query
      required: false
      schema:
        type: string
      description: ID of item after which the collection should be returned. More examples and info about pagination [in our guides](https://developers.myclickfunnels.com/docs/pagination).
  schemas:
    CoursesLessonParametersUpdate:
      type: object
      title: Lessons
      description: Lessons
      required: []
      properties:
        title:
          type: string
          description: Title
        body:
          type:
          - string
          - 'null'
          description: Description
        lesson_content:
          type:
          - string
          - 'null'
          description: Markdown lesson content. This is the primary content field for the lesson body. It is Markdown, not PML. See [Lessons](https://accounts.myclickfunnels.com/.well-known/courses/skill.md#lessons) in the [Courses Skill](https://accounts.myclickfunnels.com/.well-known/courses/skill.md).
        image_id:
          type:
          - string
          - 'null'
          description: Public ID of an image in the workspace to use as the lesson image.
      example:
        courses_lesson:
          title: Lesson 1
          body: Example Lesson
          lesson_content: '## Welcome

            This is the lesson content.'
    CoursesLessonAttributes:
      type: object
      title: Lessons
      description: Lessons
      properties:
        id:
          type: integer
          description: ID
        public_id:
          type:
          - string
          - 'null'
          description: Public ID
        title:
          type: string
          description: Title
        body:
          type:
          - string
          - 'null'
          description: Description
        section_id:
          type:
          - integer
          - 'null'
          description: Parent module
        published_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Schedule for
        current_path:
          type:
          - string
          - 'null'
          description: Current Path
        sort_order:
          type:
          - integer
          - 'null'
          description: Builder display order of the lesson within its section (section_id). Scoped per section, starting at 0.
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Added
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Updated
      example:
        id: 1
        public_id: ucGpIe
        title: Lesson 1
        body: Example Lesson
        section_id: 2
        published_at: '2025-01-01T00:00:00.000Z'
        current_path: null
        sort_order: 0
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
      required:
      - body
      - created_at
      - current_path
      - id
      - public_id
      - published_at
      - section_id
      - sort_order
      - title
      - updated_at
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com