Skip to content
Project MS Docs

Create multiple students in bulk

POST
/students/batchCreate

Create or update multiple students at once (teacher role required)

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
object
students
required

Array of students to create or update

Array<object>
>= 1 items
object
email
required

Email address of the student

string format: email
>= 8 characters <= 100 characters
student_name
required

Name of the student

string
>= 4 characters <= 100 characters
class_code

Optional class code for the student

string
<= 16 characters

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Bulk operation completed successfully

object
success
required

Indicates if the request was successful

boolean
message
required

Response message

string
success
boolean
message
string
Allowed values: OK
data
object
message
string
Allowed values: success!

400

Section titled “400 ”

Bad request - invalid input

object
success
required

Indicates if the request was successful

boolean
message
required

Response message

string
success
boolean
message
string
Allowed values: BAD_REQUEST

401

Section titled “401 ”

Unauthorized - authentication required

object
success
required

Indicates if the request was successful

boolean
message
required

Response message

string
success
boolean
message
string
Allowed values: UNAUTHORIZED

403

Section titled “403 ”

Forbidden - insufficient permissions

object
success
required

Indicates if the request was successful

boolean
message
required

Response message

string
success
boolean
message
string
Allowed values: FORBIDDEN

500

Section titled “500 ”

Internal server error

object
success
required

Indicates if the request was successful

boolean
message
required

Response message

string
success
boolean
message
string
Allowed values: INTERNAL_SERVER_ERROR