What This API Endpoint Does

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

Endpoints

  • PUT /learning-paths/{learningPathId}/users/{userId} - enroll a single user in a learning path

  • PUT /learning-paths/{learningPathId}/groups/{groupId} - enroll a group of users in a learning path

  • DELETE /learning-paths/{learningPathId}/users/{userId} - unenroll a single user from a learning path

  • DELETE /learning-paths/{learningPathId}/groups/{groupId} - unenroll a group of users from a learning path

Everyone Group

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

Enroll User

PUT /learning-paths/{learningPathId}/users/{userId}

Success Response

204 "No Content"

Endpoint-specific Error Codes

  • learning_path_not_found - cannot enroll user in learning path because learning path does not exist

  • user_not_found - cannot enroll user in learning path because user does not exist

Enroll Group

PUT /learning-paths/{learningPathId}/groups/{groupId}

Success Response

204 "No Content"

Endpoint-specific Error Codes

  • learning_path_not_found - cannot enroll group in learning path because learning path does not exist

  • group_not_found - cannot enroll group in learning path because group does not exist

Unenroll User

DELETE /learning-paths/{learningPathId}/users/{userId}

Success Response

204 "No Content"

Endpoint-specific Error Codes

  • learning_path_not_found - cannot unenroll user from learning path because learning path does not exist

  • user_not_found - cannot unenroll user from learning path because user does not exist

Unenroll Group

DELETE /learning-paths/{learningPathId}/groups/{groupId}

Success Response

204 "No Content"

Endpoint-specific Error Codes

  • learning_path_not_found - cannot unenroll group from learning path because learning path does not exist

  • group_not_found - cannot unenroll group from learning path because group does not exist

Did this answer your question?