Docs home

Unarchive Students

Restores an archived learner: makes them active again in all their organizations and unblocks their account so they can log in. Use it to undo "Archive Student".

POST/unarchive/student/{studentId}
Unarchive Students
curl --request POST \
  --url 'https://<your-api-host>/nuSource/api/v1/unarchive/student/{studentId}' \
  --header 'APIKEY: <your-api-key>' \
  --header 'ORGID: <your-org-id>' \
  --form 'JSONString={"user_id":"<studentId>","organization_id":<organizationId>}'
{
  "code": 200,
  "message": "Success"
}

Access: Institute admins, plus custom roles that can delete learners. You must be an admin or custom-role member of the organization you act in.

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

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

BodyJSONString
Organization whose learner limit is checked and where the note is saved. Defaults to your ORGID organization.
Response200application/json
codeinteger
Example: 200
messagestring
Example: Success

Notes: Fails if unarchiving would take you over your plan's learner limit, or with "Student un-archive not allowed" if you are not an admin of that organization. Class and batch access that was cancelled at archiving is not restored; enroll the learner again if needed. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.

Updated yesterday

Ask AI