> ## Documentation Index
> Fetch the complete documentation index at: https://docs.myustadia.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Enroll

> Enroll the header learner in a listed, in-org course.

Auth: portal API key + X-Learner-Email header (see module docstring).

Idempotent: a repeat enroll does not error or reset progress; it bumps
last_opened_at and returns the existing enrollment_id + current
completion_pct.

404 (opaque, no oracle) whenever the course cannot be enrolled into:
course not found, not listed in the caller's org catalog, wrong owner,
cross-org, or unverified when the org requires verification. All of these
collapse to the same "Course not found" response so a caller cannot probe
catalog visibility rules by watching the error vary.

Returns 200 {enrollment_id: int, completion_pct: float} (0.0 on first
enroll).



## OpenAPI

````yaml /openapi.yaml post /api/v1/learn/courses/{course_id}/enroll
openapi: 3.1.0
info:
  title: Mahara Platform
  description: >
    AI Sales Training Course Generator, a Coursera-style platform.


    ## Authentication


    Every request must carry your API key as a Bearer token:


    `Authorization: Bearer sk_live_your_key_here`


    ## Getting an API key


    API keys are provisioned by our team. They are not self-service, so there is
    no signup page to apply on. To request access, email **sales@myustadia.com**
    and we will issue a key for your account.
  version: 1.0.0
servers: []
security: []
paths:
  /api/v1/learn/courses/{course_id}/enroll:
    post:
      tags:
        - B2B Learn
      summary: Enroll
      description: >-
        Enroll the header learner in a listed, in-org course.


        Auth: portal API key + X-Learner-Email header (see module docstring).


        Idempotent: a repeat enroll does not error or reset progress; it bumps

        last_opened_at and returns the existing enrollment_id + current

        completion_pct.


        404 (opaque, no oracle) whenever the course cannot be enrolled into:

        course not found, not listed in the caller's org catalog, wrong owner,

        cross-org, or unverified when the org requires verification. All of
        these

        collapse to the same "Course not found" response so a caller cannot
        probe

        catalog visibility rules by watching the error vary.


        Returns 200 {enrollment_id: int, completion_pct: float} (0.0 on first

        enroll).
      operationId: enroll_api_v1_learn_courses__course_id__enroll_post
      parameters:
        - name: course_id
          in: path
          required: true
          schema:
            type: string
            title: Course Id
        - name: X-Learner-Email
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Learner-Email
        - name: X-Learner-Sig
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Learner-Sig
        - name: X-Learner-Sig-Ts
          in: header
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: X-Learner-Sig-Ts
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````