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

# Update Lesson Plan

> Update a lesson plan (partial — send only fields to change).

404 unless the plan's `organization_id` is your org. Any newly referenced
classroom/group/student must also belong to your org. Returns the full updated plan.



## OpenAPI

````yaml /openapi.json put /v1/lesson-plans/{plan_id}
openapi: 3.1.0
info:
  title: ClassQuill Public API
  description: >-
    REST API for ClassQuill tutoring organisations. Pipe your sessions,
    invoices, payments, tutor earnings, students, and more into your own tools.
    Most endpoints are reads; a focused set of writes (each gated by a *:write
    scope) create or update data, including creating student/tutor/parent
    accounts.


    Authenticate every request with an org API key:

        Authorization: Token token=cq_live_...

    Mint keys in the ClassQuill app under Settings → Developers.
  version: 1.0.0
servers: []
security:
  - ApiKeyAuth: []
tags:
  - name: General
  - name: Sessions
  - name: Tutors
  - name: Students & Parents
  - name: Billing
  - name: Curriculum
  - name: Coursework
  - name: Operations
  - name: Pricing
  - name: Bookings
  - name: Blog
  - name: Reports
paths:
  /v1/lesson-plans/{plan_id}:
    put:
      tags:
        - Coursework
      summary: Update Lesson Plan
      description: >-
        Update a lesson plan (partial — send only fields to change).


        404 unless the plan's `organization_id` is your org. Any newly
        referenced

        classroom/group/student must also belong to your org. Returns the full
        updated plan.
      operationId: update_lesson_plan_v1_lesson_plans__plan_id__put
      parameters:
        - name: plan_id
          in: path
          required: true
          schema:
            type: string
            title: Plan Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LessonPlanUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LessonPlan'
        '401':
          description: Missing, malformed, revoked, or expired credentials.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '403':
          description: The credential lacks the scope this endpoint requires.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '404':
          description: >-
            Not found — the record doesn't exist or belongs to another
            organisation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '422':
          description: Validation error — `error.details.errors` lists the fields.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
        '429':
          description: >-
            Rate limit exceeded — honour Retry-After and the RateLimit-*
            headers.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
components:
  schemas:
    LessonPlanUpdate:
      properties:
        scope:
          anyOf:
            - type: string
            - type: 'null'
          title: Scope
        classroom_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Classroom Id
        group_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Group Id
        student_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Student Id
        session_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Session Id
        math_level_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Math Level Id
        curriculum_level_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Curriculum Level Ids
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        plan_data:
          anyOf:
            - $ref: '#/components/schemas/PlanData'
            - type: 'null'
        scheduled_for:
          anyOf:
            - type: string
            - type: 'null'
          title: Scheduled For
      additionalProperties: false
      type: object
      title: LessonPlanUpdate
      description: |-
        PUT /v1/lesson-plans/{id} → lesson_plans. All fields optional (partial
        update); the row's created_by must be a member of the key's org.
    LessonPlan:
      properties:
        id:
          type: string
          title: Id
        created_by:
          anyOf:
            - type: string
            - type: 'null'
          title: Created By
        scope:
          anyOf:
            - type: string
            - type: 'null'
          title: Scope
        classroom_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Classroom Id
        group_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Group Id
        student_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Student Id
        session_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Session Id
        math_level_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Math Level Id
        curriculum_level_ids:
          items:
            type: string
          type: array
          title: Curriculum Level Ids
          default: []
        title:
          anyOf:
            - type: string
            - type: 'null'
          title: Title
        status:
          anyOf:
            - type: string
            - type: 'null'
          title: Status
        plan_data:
          $ref: '#/components/schemas/PlanData'
        scheduled_for:
          anyOf:
            - type: string
            - type: 'null'
          title: Scheduled For
        created_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Created At
        updated_at:
          anyOf:
            - type: string
            - type: 'null'
          title: Updated At
      type: object
      required:
        - id
      title: LessonPlan
    ApiError:
      description: Canonical error envelope for every /v1 error response (4xx/5xx).
      properties:
        error:
          $ref: '#/components/schemas/ApiErrorBody'
      required:
        - error
      title: ApiError
      type: object
    PlanData:
      properties: {}
      additionalProperties: true
      type: object
      title: PlanData
      description: >-
        Free-form lesson-plan body (learning_objectives, lesson_hook,
        activities,

        worked_examples, exit_ticket, notes, …). Arbitrary keys are preserved.
        Shared

        by the read + write lesson-plan models so the OpenAPI has a single
        `PlanData`

        component — SDK generators choke on duplicate inline object schemas.
    ApiErrorBody:
      description: The `error` object every /v1 error response carries.
      properties:
        code:
          description: >-
            Stable machine-readable error code: bad_request, unauthorized,
            forbidden, not_found, conflict, validation_error, rate_limited, or
            internal_error.
          examples:
            - not_found
          title: Code
          type: string
        message:
          description: Human-readable explanation, safe to surface to end users.
          examples:
            - Session not found
          title: Message
          type: string
        status:
          description: The HTTP status code, repeated in the body.
          examples:
            - 404
          title: Status
          type: integer
        details:
          additionalProperties: true
          description: >-
            Error-specific context. 422 carries the field errors under `errors`;
            429 carries `retry_after_seconds`.
          title: Details
          type: object
      required:
        - code
        - message
        - status
      title: ApiErrorBody
      type: object
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Org API key as `Token token=cq_live_...`

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.