Unenrols a student from the course.

Endpoint

• Method: DELETE

• Path: /admin/courses/{course_id}/students/{student_id}

• Edition: Core

• Controller: CourseAdminController@removeStudent

• Route source: fluent-community/Modules/Course/Http/course_api.php:31

• Controller source: fluent-community/Modules/Course/Http/Controllers/CourseAdminController.php

• Requires a course admin for this course, or a WordPress user with manage_options.

• Destructive: removing the enrolment also removes the progress tied to it, so re-adding the student does not restore their completions.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

DELETE Remove Course Student

DELETE

/admin/courses/{course_id}/students/{student_id}

Unenrols a student from the course.

Controller: CourseAdminController@removeStudent
Route source: fluent-community/Modules/Course/Http/course_api.php:31

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type

API Key (header: Authorization)

Parameters

Path Parameters

course_id*

Course ID extracted from the URL path.

Type

integer

Required

student_id*

Student ID extracted from the URL path.

Type

integer

Required

Responses

Successful response

Content-Type

application/json

{

  

"message": "string"

}

DELETE

/admin/courses/{course_id}/students/{student_id}

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

course_id*

student_id*

Samples

Powered by VitePress OpenAPI