Creating a New Student
Adds one or more learners to your organization in a single call. If someone in your institute already has that email (or phone number, when no email is given), they're added to this organization instead of getting a second account.
/organization/studentscurl --request POST \
--url 'https://<your-api-host>/nuSource/api/v1/organization/students' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>' \
--form 'JSONString={
"emails": [
{
"contact_number_country_id": 103,
"contact_number_dial_code": "+91",
"email": "<$randomEmail>",
"name": "<$randomUserName>",
"organization_id": <organizationId>,
"password": "test",
"contact_number": "<$randomPhoneNumber>",
"external_uuid":"6880895a2ad4e601c26cd9f3"
}
]
}'{
"code": 200,
"message": "Students Added Successfuly",
"failed_admin_emails": [],
"failed_tutor_emails": [],
"accepted_emails": [],
"invalid_emails": [],
"user_ids": [
43974
]
}Access: Institute admins, plus custom roles that can create learners or admissions.
Request body: form-data with one field, JSONString, containing this JSON:
JSONStringORGID organization. Each learner object can override it.Fields in each emails object:
| Name | Required | Type | Description |
|---|---|---|---|
| One of email or contact_number | string | Also used to find an existing user. | |
| contact_number | One of email or contact_number | string | Mobile number. Used to find an existing user when there's no email. |
| contact_number_country_id | When contact_number is sent | integer | Country of the number (country_code_id from "Countries List"). |
| name | No | string | Full name. |
| password | No | string | Up to 20 characters. If left out, a random 8-character password is set. |
| reg_no | No | string | Registration number in this organization. |
| contact_number_2 | No | string | Second mobile number. Needs contact_number_2_country_id. |
| first_name, last_name | No | string | Name parts. |
| address | No | string | Address. |
| birthday | No | string | Date of birth, e.g. 2005-08-15. |
| external_uuid | No | string | Your own ID for the learner, so you can find them later with "Get User Details by External UUID". |
| custom_fields | No | array | Signup custom field values for the new learner. |
| organization_id | No | integer | Overrides the top-level organization_id for this learner. |
200Students Added SuccessfulyNotes: All or nothing: if any entry is invalid, the whole request fails and nobody is added. The errors are "Please enter a valid email, mobile number and password." or "Please provide at least one contact information". New learners are added with status Registered and get a signup email once the request finishes. Rate limit: 30 requests per minute; going over locks you out for 30 minutes.