Docs home

Archive Student

Archives a learner: removes them from your organizations, cancels their place in every class and batch of those organizations, and blocks their account so they can no longer log in. Use it when a learner leaves. Undo it with "Unarchive Students".

POST/remove/organization/student/{studentId}
Archive Student
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/remove/organization/student/{studentId}' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"notes":"Archive+Notes"}'
{
  "code": 200,
  "message": "Student removed successfuly"
}

Access: Institute admins, plus custom roles that can delete learners.

Path parameters
student_idintegerrequired
ID of the learner, e.g. remove/organization/student/43974.

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

BodyJSONString
notesstringrequired
Reason for archiving. Saved as a note on the learner.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Student removed successfuly

Notes: The learner is archived in every organization you belong to, not just your ORGID one. Course enrollments and payments are not deleted, but class and batch access is cancelled and is not restored by unarchiving. Errors: "Invalid student id" (the learner is not in any of your organizations) and "Default Student Cannot Be Archived" (the institute's built-in sample learner). Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI