Imports students into a course from submitted rows, creating WordPress users for addresses that do not yet exist.

The response reports per-batch counts so a large import can be driven in chunks from the client.

Endpoint

• Method: POST

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

• Edition: PRO

• Controller: BulkMembersController@bulkImportStudents

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

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

• Requires a course admin for this course.

• Requires FluentCommunity Pro.

• Can create new WordPress user accounts and, depending on the payload, send them welcome email.

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 Import Students

POST

/admin/courses/{course_id}/students/bulk-import

Imports students into a course from submitted rows, creating WordPress users for addresses that do not yet exist.

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

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

{

  

"emails": "string"

}

Responses

Successful response

Content-Type

application/json

{

  

"added": 0,

  

"failed": 0,

  

"has_more": true,

  

"message": "string",

  

"processed": 0,

  

"skipped": 0,

  

"total": 0

}

POST

/admin/courses/{course_id}/students/bulk-import

Playground

Authorization

ApplicationPasswords

Variables

Key

Value

course_id*

Body

Samples

Powered by VitePress OpenAPI