openapi: 3.2.0
info:
  title: ClickFunnels Courses::Enrollment 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::Enrollment
  description: '> Controls access to course sections and lessons


    By purchasing or otherwise opting into a course, an enrollment record is created. Enrollments

    dictate which sections, sub-sections, and lessons the student can access.


    Progress for an enrollment can be tracked for a Course, Section, and Lesson.


    To grant course access from an automation instead of creating enrollments directly, see [Step catalog](https://accounts.myclickfunnels.com/.well-known/workflows/skill.md#step-catalog) in the [Workflows Skill](https://accounts.myclickfunnels.com/.well-known/workflows/skill.md).

    '
paths:
  /courses/{course_id}/enrollments:
    get:
      tags:
      - Courses::Enrollment
      summary: List Enrollments
      description: List enrollments for a course
      operationId: listCoursesEnrollments
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      - $ref: '#/components/parameters/after'
      - $ref: '#/components/parameters/sort_order'
      - $ref: '#/components/parameters/sort_property'
      - name: filter
        in: query
        description: 'Filter by available properties in query params, like this: `api/v2/resources?filter[id]=value&filter[another_property]=value1,value2`. Check our Filtering guide for examples and all about filtering [here](https://developers.myclickfunnels.com/docs/filtering).

          '
        required: false
        schema:
          type: object
          properties:
            contact_id:
              type: string
              description: A comma-separated list of contact IDs to filter by.
              example: 1,42
            id:
              type: string
              description: A comma-separated list of enrollment IDs to filter by.
              example: 1,2,3
        style: deepObject
        explode: true
      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/CoursesEnrollmentAttributes'
              example:
              - id: 3
                public_id: Srohqc
                contact_id: 49
                course_id: 16
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                suspended: false
                suspension_reason: Call in to reapply after robot incident
                current_path: /enrollments/17cadca5ec21c9c4aede396f1e2104138b4897e43a1a974026bd0fb407556d2c65
                origination_source_type: Membership
                origination_source_id: 60
                contact:
                  id: 24359
                  public_id: vQxYMj
                  email_address: jane.doe@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: '+18005550199'
              - id: 4
                public_id: QgKoUb
                contact_id: 50
                course_id: 17
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                suspended: false
                suspension_reason: Call in to reapply after robot incident
                current_path: /enrollments/17cadca5ec21c9c4aede396f1e2104138b4897e43a1a974026bd0fb407556d2c65
                origination_source_type: Membership
                origination_source_id: 61
                contact:
                  id: 24359
                  public_id: vQxYMj
                  email_address: jane.doe@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: '+18005550199'
        '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::Enrollment
      summary: Create Enrollment
      description: Add a new enrollment
      operationId: createCoursesEnrollments
      parameters:
      - name: course_id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        description: Information about a new Enrollment
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                courses_enrollment:
                  type: object
                  $ref: '#/components/schemas/CoursesEnrollmentParameters'
            example:
              courses_enrollment:
                contact_id: 3
                suspended: false
                suspension_reason: Call in to reapply after robot incident
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoursesEnrollmentAttributes'
              example:
                id: 6
                public_id: WvIRKa
                contact_id: 52
                course_id: 19
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                suspended: false
                suspension_reason: Call in to reapply after robot incident
                current_path: /enrollments/17cadca5ec21c9c4aede396f1e2104138b4897e43a1a974026bd0fb407556d2c65
                origination_source_type: Membership
                origination_source_id: 63
                contact:
                  id: 24359
                  public_id: vQxYMj
                  email_address: jane.doe@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: '+18005550199'
        '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
  /courses/enrollments/{id}:
    get:
      tags:
      - Courses::Enrollment
      summary: Fetch Enrollment
      description: Retrieve an enrollment
      operationId: getCoursesEnrollments
      parameters:
      - $ref: '#/components/parameters/id'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoursesEnrollmentAttributes'
              example:
                id: 5
                public_id: JvtRKP
                contact_id: 51
                course_id: 18
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                suspended: false
                suspension_reason: Call in to reapply after robot incident
                current_path: /enrollments/17cadca5ec21c9c4aede396f1e2104138b4897e43a1a974026bd0fb407556d2c65
                origination_source_type: Membership
                origination_source_id: 62
                contact:
                  id: 24359
                  public_id: vQxYMj
                  email_address: jane.doe@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: '+18005550199'
        '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::Enrollment
      summary: Update Enrollment
      description: Update an enrollment
      operationId: updateCoursesEnrollments
      parameters:
      - $ref: '#/components/parameters/id'
      requestBody:
        description: Information about updated fields in Enrollment
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                courses_enrollment:
                  type: object
                  $ref: '#/components/schemas/CoursesEnrollmentParametersUpdate'
            example:
              courses_enrollment:
                suspended: false
                suspension_reason: Call in to reapply after robot incident
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CoursesEnrollmentAttributes'
              example:
                id: 8
                public_id: jhtPUX
                contact_id: 54
                course_id: 21
                created_at: '2025-01-01T00:00:00.000Z'
                updated_at: '2025-01-01T00:00:00.000Z'
                suspended: false
                suspension_reason: Call in to reapply after robot incident
                current_path: /enrollments/17cadca5ec21c9c4aede396f1e2104138b4897e43a1a974026bd0fb407556d2c65
                origination_source_type: Membership
                origination_source_id: 65
                contact:
                  id: 24359
                  public_id: vQxYMj
                  email_address: jane.doe@example.com
                  first_name: Jane
                  last_name: Doe
                  phone_number: '+18005550199'
        '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'
components:
  schemas:
    CoursesEnrollmentParametersUpdate:
      type: object
      title: Enrollments
      description: Enrollments
      required: []
      properties:
        suspended:
          type:
          - boolean
          - 'null'
          description: Suspended
        suspension_reason:
          type:
          - string
          - 'null'
          description: Suspension Reason
      example:
        courses_enrollment:
          suspended: false
          suspension_reason: Call in to reapply after robot incident
    CoursesEnrollmentAttributes:
      type: object
      title: Enrollments
      description: Enrollments
      properties:
        id:
          type: integer
          description: Enrollment ID
        public_id:
          type:
          - string
          - 'null'
          description: Enrollment public ID
        contact_id:
          type: integer
          description: Contact ID
        course_id:
          type: integer
          description: Course
        created_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Added
        updated_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Updated
        suspended:
          type:
          - boolean
          - 'null'
          description: Suspended
        suspension_reason:
          type:
          - string
          - 'null'
          description: Suspension Reason
        current_path:
          type:
          - string
          - 'null'
          description: Current Path
        origination_source_type:
          type:
          - string
          - 'null'
          description: Origination Source Type
        origination_source_id:
          type: integer
          description: Origination Source ID
        contact:
          $ref: '#/components/schemas/ContactShortAttributes'
      example:
        id: 1
        public_id: kvqOCw
        contact_id: 3
        course_id: 2
        created_at: '2025-01-01T00:00:00.000Z'
        updated_at: '2025-01-01T00:00:00.000Z'
        suspended: false
        suspension_reason: Call in to reapply after robot incident
        current_path: /enrollments/17cadca5ec21c9c4aede396f1e2104138b4897e43a1a974026bd0fb407556d2c65
        origination_source_type: Membership
        origination_source_id: 3
        contact:
          id: 24359
          public_id: vQxYMj
          email_address: jane.doe@example.com
          first_name: Jane
          last_name: Doe
          phone_number: '+18005550199'
      required:
      - contact
      - contact_id
      - course_id
      - created_at
      - current_path
      - id
      - origination_source_id
      - origination_source_type
      - public_id
      - suspended
      - suspension_reason
      - updated_at
    ContactShortAttributes:
      type: object
      title: Contact (Short)
      description: A compact contact representation used in nested resources.
      properties:
        id:
          type: integer
          description: The ID of the contact.
        public_id:
          type: string
          description: The public ID of the contact.
        email_address:
          type: string
          description: The email address of the contact.
        first_name:
          type:
          - string
          - 'null'
          description: The first name of the contact.
        last_name:
          type:
          - string
          - 'null'
          description: The last name of the contact.
        phone_number:
          type:
          - string
          - 'null'
          description: The phone number of the contact.
      example:
        id: 24359
        public_id: vQxYMj
        email_address: jane.doe@example.com
        first_name: Jane
        last_name: Doe
        phone_number: '+18005550199'
      required:
      - email_address
      - first_name
      - id
      - last_name
      - phone_number
      - public_id
    CoursesEnrollmentParameters:
      type: object
      title: Enrollments
      description: Enrollments
      required:
      - contact_id
      properties:
        contact_id:
          type: integer
          description: Contact ID
        suspended:
          type:
          - boolean
          - 'null'
          description: Suspended
        suspension_reason:
          type:
          - string
          - 'null'
          description: Suspension Reason
      example:
        courses_enrollment:
          contact_id: 3
          suspended: false
          suspension_reason: Call in to reapply after robot incident
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
    sort_property:
      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:
      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).
  headers:
    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
    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
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
externalDocs:
  description: More in-depth guides and further resources
  url: https://developers.myclickfunnels.com