Admin - Holiday Courses

Update Course Structure

Changed on

Update the entire course structure by replacing the units array.

This endpoint allows admins to:

  • Reorder units within a course
  • Modify unit titles, summaries, types, and content
  • Add or remove units
  • Update the complete course structure in a single operation

The endpoint validates that the course is a holiday_workbook type to ensure admins are only structurally editing these types of courses.

Only accessible by admin users.

put/admin/holiday-courses/courses/{course_id}/structure

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/admin/holiday-courses/courses/{course_id}/structure
  • Auth: OAuth 2 (password, token URL api/login)

Path parameters

course_idstring required

The ID of the course to update

Request body

Response

Successful Response

_idstring
user_idstring required
is_teacher_courseboolean
folder_idstring nullable
titlestring required
subjectstring nullable
status'UPLOADING' | 'PROCESSING_IMAGES' | 'STRUCTURING' | 'GENERATING_CONTENT' | 'COMPLETED' | 'FAILED'
original_image_pathsstring[]
raw_content_blobstring nullable
generated_course_contentstring nullable
revision_deck_status'GENERATING' | 'COMPLETED' | 'FAILED' nullable
knowledge_quiz_status'GENERATING' | 'COMPLETED' | 'FAILED' nullable
append_status'GENERATING' | 'COMPLETED' | 'FAILED' nullable
append_started_atstring date-time nullable
append_error_messagestring nullable
error_messagestring nullable
warningsstring[] nullable
figures_cropobject nullable
processing_optionsobject nullable
source_type'student_upload' | 'teacher_assigned' | 'holiday_workbook' | 'excellence_course' nullable
excellence_course_keystring nullable
excellence_content_signaturestring nullable
excellence_unmodifiedboolean nullable
holiday_course_contextobject nullable
created_atstring date-time
updated_atstring date-time

Changes

  • 7925dd21e4d0Revision changes
    • warning

      added the new excellence_course enum value to the / response property for the response status

    • warning

      added the new interactive enum value to the ////// response property for the response status

    • warning

      added the new video enum value to the ////// response property for the response status

    • info

      added the new interactive enum value to the request property /////

    • info

      added the new video enum value to the request property /////

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • c81ed506912fRevision changes
    • info

      added the new optional request property //

    • info

      added the optional property /// to the response with the status