Skip to content

Enrols many users in a course in one call, either from an explicit id list or by copying the membership of another space or course in batches.

Send up to 500 ids in user_ids; larger payloads are rejected with a 413 so the client must chunk them. With no ids the request is treated as a source-copy batch and the response reports how many were added, skipped and failed so the client can resume from the returned offset.

Endpoint

  • Method: POST

  • Path: /admin/courses/{course_id}/students/bulk-add

  • Edition: PRO

  • Controller: BulkMembersController@bulkAddStudents

  • Route source: fluent-community-pro/app/Http/Routes/api.php:115

  • Controller source: fluent-community-pro/app/Http/Controllers/BulkMembersController.php

  • Requires a course admin for this course.

  • Requires FluentCommunity Pro.

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.

POST Post Bulk Add Students

POST
/admin/courses/{course_id}/students/bulk-add

Enrols many users in a course in one call, either from an explicit id list or by copying the membership of another space or course in batches.

Controller: BulkMembersController@bulkAddStudents
Route source: fluent-community-pro/app/Http/Routes/api.php:115

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

Request Body

application/json
JSON
{
  
"user_ids": [
  
  
"string"
  
]
}

Responses

Successful response

application/json
JSON
{
  
"added": 0,
  
"failed": 0,
  
"has_more": true,
  
"message": "string",
  
"processed": 0,
  
"skipped": 0,
  
"total": 0
}

Playground

Authorization
Variables
Key
Value
Body

Samples

Powered by VitePress OpenAPI

FluentCommunity developer documentation