What This API Endpoint Does

The Course Enrollments API enrolls or unenrolls a user or group in a course. When it's used, admins see the user or group added to or removed from the relevant tab on the course details page. Learners see the course added to or removed from their Assigned to me tab.

Endpoints

  • PUT /courses/{courseId}/users/{userId} - enroll a single user in a course

  • PUT /courses/{courseId}/groups/{groupId} - enroll a group of users in a course

  • DELETE /courses/{courseId}/users/{userId} - unenroll a single user from a course

  • DELETE /courses/{courseId}/groups/{groupId} - unenroll a group of users from a course

Everyone Group

To enroll the Everyone group (i.e., every user in your Rise.com account) in a course, use everyone for the groupId

Enroll User

PUT /courses/{courseId}/users/{userId}

Success Response

204 "No Content"

Endpoint-specific Error Codes

  • course_not_found - cannot enroll user in course because course does not exist

  • user_not_found - cannot enroll user in course because user does not exist

Enroll Group

PUT /courses/{courseId}/groups/{groupId}

Success Response

204 "No Content"

Endpoint-specific Error Codes

  • course_not_found - cannot enroll group in course because course does not exist

  • group_not_found - cannot enroll group in course because group does not exist

Unenroll User

DELETE /courses/{courseId}/users/{userId}

Success Response

204 "No Content"

Endpoint-specific Error Codes

  • course_not_found - cannot unenroll user from course because course does not exist

  • user_not_found - cannot unenroll user from course because user does not exist

Unenroll Group

DELETE /courses/{courseId}/groups/{groupId}

Success Response

204 "No Content"

Endpoint-specific Error Codes

  • course_not_found - cannot unenroll group from course because course does not exist

  • group_not_found - cannot unenroll group from course because group does not exist

Did this answer your question?