Docs home

Remove Student from Batch

Removes a learner from a batch and from all its classes. The learner keeps their account and their other batches.

POST/masterbatch/classstudents/{studentId}/remove
Remove Student from Batch
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/masterbatch/classstudents/{studentId}/remove' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"class_id":<classId>}'
{
  "code": 200,
  "message": "Deleted"
}

Access: Admins and custom roles of the organization that owns the batch.

Request body: form-data with one field, JSONString, containing this JSON:

Path parameters
student_idintegerrequired
The learner's user ID (the number in the URL before /remove).
BodyJSONString
class_idintegerrequired
The batch ID (master_batch_id) to remove the learner from.
Response200application/json
codeinteger
Example: 200
messagestring
"Deleted"
Example: Deleted

Notes: The enrolment is marked as removed from today, not deleted, so past attendance and progress stay. The learner is also taken out of the batch's community. Anyone else gets "Invalid user ID". Rate limit: 30 requests per 1 minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI