AI Primary
PATCH /lessons/{id}/status
Bearer auth

Updates the status of a lesson.

Path parameters

  • id string Required

    The lesson ID

application/json

Body Required

  • status string Required

    New status

    Values are draft, planning, in-progress, completed, or archived.

  • notes string

    Optional notes about the status change

Responses

  • 200 application/json

    Lesson status updated successfully

    Hide response attributes Show response attributes object
    • success boolean
    • code integer(int32)
    • message string
    • data object

      Lesson plan object representing a detailed plan for teaching or assignment

      Hide data attributes Show data attributes object
      • id string Required

        Unique identifier for the lesson

      • classId string Required

        ID of the class

      • authorId string Required

        ID of the teacher/author

      • title string Required

        Title of the lesson

        Maximum length is 200.

      • subject string | null

        Subject code (e.g., Math-1)

      • content string Required

        Lesson content or instructions

      • type string

        Type of lesson

        Values are assignment, material, lecture, or quiz.

      • status string

        Status of the lesson

        Values are draft, published, or archived.

      • learningObjectives array[object] | null

        Array of learning objectives

        Hide learningObjectives attributes Show learningObjectives attributes object
        • description string
        • type string
        • isAchieved boolean
        • notes string | null
      • lessonPlan string | null

        Private teacher notes/plan (not visible to students)

      • maxPoints integer | null

        Maximum points for assignments

      • dueDate string(date-time) | null

        Due date for assignments

      • createdAt string(date-time)

        Timestamp when the lesson was created

      • updatedAt string(date-time)

        Timestamp when the lesson was last updated
  • 400 application/json

    Bad Request - Invalid input data

    Hide response attributes Show response attributes object
    • success boolean
    • code integer
    • errorCode string
    • message string
    • timestamp string(date-time)
  • 404 application/json

    Lesson not found

    Hide response attributes Show response attributes object
    • success boolean
    • code integer
    • errorCode string
    • message string
    • timestamp string(date-time)
  • 500 application/json

    Internal Server Error

    Hide response attributes Show response attributes object
    • success boolean
    • code integer
    • errorCode string
    • message string
    • timestamp string(date-time)
PATCH /lessons/{id}/status 
curl \
 --request PATCH 'http://localhost:8080/api/lessons/{id}/status' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"status":"in-progress","notes":"Started teaching this lesson"}'
Request examples 
{
  "status": "in-progress",
  "notes": "Started teaching this lesson"
}
Response examples (200) 
{
  "success": true,
  "code": 200,
  "message": "string",
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440005",
    "classId": "550e8400-e29b-41d4-a716-446655440000",
    "authorId": "550e8400-e29b-41d4-a716-446655440001",
    "title": "Quadratic Equations",
    "subject": "MATH101",
    "content": "Students will learn to solve quadratic equations...",
    "type": "lecture",
    "status": "published",
    "learningObjectives": [
      {
        "description": "Students will be able to solve quadratic equations",
        "type": "knowledge",
        "isAchieved": false,
        "notes": "string"
      }
    ],
    "lessonPlan": "Start with examples, then practice problems",
    "maxPoints": 100,
    "dueDate": "2024-09-30T23:59:59Z",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-09-20T14:45:00Z"
  }
}
Response examples (400) 
{
  "success": false,
  "code": 42,
  "errorCode": "string",
  "message": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}
Response examples (404) 
{
  "success": false,
  "code": 42,
  "errorCode": "string",
  "message": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}
Response examples (500) 
{
  "success": false,
  "code": 42,
  "errorCode": "string",
  "message": "string",
  "timestamp": "2026-05-04T09:42:00Z"
}