CourseCompletedLessons
Create CourseCompletedLesson
Create a new CourseCompletedLesson record.
POST
Create CourseCompletedLesson
A CourseCompletedLesson records that a specific
CourseMember has completed a specific CourseLesson. Each record is the junction between a lesson and the enrolled member who finished it.
These records are typically created automatically by the Members Portal when a member meets the lesson’s completion criteria (e.g. visiting the lesson page, clicking a completion button, or finishing a video). They can also be created or deleted manually via the API to manage progress programmatically.
Use this entity to query which lessons a member has completed, or to find all members who have completed a given lesson.
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 CourseCompletedLesson-Create role.Request Body
Required Fields
ID of the course lesson that was completed.
ID of the course enrolment (CourseMember) record for the member who completed the lesson.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the coursecompletedlesson was created 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
Create CourseCompletedLesson