Revoke enrollment
enrollment_revokeRevoke one learner's enrollment in a course: the enrollment record is deleted and their access ends (a waitlisted learner leaves the waitlist); to change an expiry, waitlist place or status label instead, use enrollment_update. Revoking ends access without deleting the learner's history: their progress, graded work and any issued certificate are kept, so re-enrolling them later with enrollment_create restores access with that history. No email is sent, and the account and its site membership stay. Identify the learner by email or userId, as shown in enrollment_list rows; a learner who is not enrolled in that course is a not-found error. Returns the text "Enrollment revoked." Get course ids from course_list.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Learner email; pass this or userId. | ||
| userId | No | Learner user id; pass this or email (userId wins if both are sent). | |
| courseId | Yes | Course id (required). For a course linked to Open edX this removes only the Cubite enrollment, not the learner's Open edX one. |