How can I programmatically unenroll users as an admin (not as the learner) in Open edX?

joel.edwards · October 15, 2025, 6:26am

I’m not exactly certain about this, haven’t tried any of it at all, but from what I can piece together you’ll need to use the /api/enrollment/v1/enrollment endpoint with a POST request with the key parameter used being is_active set to false.

github.com/openedx/edx-platform

openedx/core/djangoapps/enrollments/api.py

da2daf255


      
          is_active (boolean): Optional argument for making the new enrollment inactive. If not specified, is_active
              defaults to True.

There’s also a bulk enrollment api that can be enabled and used for unenrollment (according to this topic here: Programatically enroll or unenroll students)

github.com/openedx/edx-platform

lms/envs/common.py

da2daf255


      
          # .. toggle_name: settings.ENABLE_BULK_ENROLLMENT_VIEW
          # .. toggle_implementation: DjangoSetting
          # .. toggle_default: False
          # .. toggle_description: When set to True the bulk enrollment view is enabled and one can use it to enroll multiple
          #   users in a course using bulk enrollment API endpoint (/api/bulk_enroll/v1/bulk_enroll).
          # .. toggle_use_cases: open_edx
          # .. toggle_creation_date: 2017-07-15
          # .. toggle_tickets: https://github.com/openedx/edx-platform/pull/15006
          ENABLE_BULK_ENROLLMENT_VIEW = False

github.com/openedx/edx-platform

lms/djangoapps/bulk_enroll/views.py

da2daf255


      
          class BulkEnrollView(APIView):
              """
              **Use Case**
          
                  Enroll multiple users in one or more courses.
          
              **Example Request**
          
                  POST /api/bulk_enroll/v1/bulk_enroll/ {
                      "auto_enroll": true,
                      "email_students": true,
                      "action": "enroll",
                      "courses": "course-v1:edX+Demo+123,course-v1:edX+Demo2+456",
                      "cohorts": "cohortA,cohortA",
                      "identifiers": "brandon@example.com,yamilah@example.com"
                  }
          
                  **POST Parameters**
          
                    A POST request can include the following parameters.

This file has been truncated. show original

Topic		Replies	Views
Programatically enroll or unenroll students Site Operators	13	2203	July 19, 2023
Anyone plz help me, can anyone tell me how can i enroll user into a course from my local system Development api , how-to , edx-platform	2	66	December 27, 2024
Anyone plz help me, can anyone tell me how can i enroll user into a course from my local system Educators	5	107	December 27, 2024
Enrollment via API in api-docs Development tutor	1	360	March 26, 2024
API for enrollment infos Development api , how-to	5	117	September 3, 2024

How can I programmatically unenroll users as an admin (not as the learner) in Open edX?

Related topics