CourseSections
Update CourseSection
Update an existing CourseSection record.
PUT
Update CourseSection
Updates an existing CourseSection record. You must include the
Id of the record to update along with all required fields.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CourseSection-Edit role.Enums
eLessonUnlockType — UnlockType values
eLessonUnlockType — UnlockType values
| Value | Name |
|---|---|
| 1 | Immediate |
| 2 | Sequential |
| 3 | Timed |
Request Body
Required Fields
The Id of the CourseSection record to update.
ID of the course this section belongs to.
Section title displayed to members.
Position of the section within the course; lower numbers appear first.
When the section becomes available: Immediate (1), after the previous section is done — Sequential (2), or after a set number of days — Timed (3).
Number of days after enrolment before the section unlocks; only used when UnlockType is Timed (3).
Optional Fields
Optional HTML or rich-text introductory content shown at the top of the section.
Whether the section is active and visible to enrolled members.
URL of a new thumbnail image to upload (JPG/JPEG, PNG, or GIF, max 10 MB).
Set to true to remove the existing thumbnail image.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the update.
Contains the
Id of the updated record.true if the coursesection was updated successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Update CourseSection