CourseMembers
Create CourseMember
Create a new CourseMember record.
POST
Create CourseMember
A CourseMember represents a customer’s enrolment in a
Course. When a customer signs up to a course through the Members Portal they are automatically added as a CourseMember. Members can also be added manually via the Admin Panel or the API.
Each CourseMember record tracks the member’s progress (LastCompletedLessonId, LastAccess) and their access status:
Approved— the member has been approved to access the course content. For public courses this is set automatically on sign-up; for private or paid courses an administrator may need to approve the enrolment.Blocked— the member has been blocked from accessing the course.
CourseCompletedLesson records to query which individual lessons a member has completed.
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 CourseMember-Create role.Request Body
Required Fields
ID of the course the member is enrolled in.
ID of the customer enrolled in the course.
Optional Fields
Whether the member has been approved to access the course content.
Whether the member has been blocked from accessing the course.
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 coursemember 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 CourseMember