Update Student Info
Updates a learner's profile: contact details, personal details, guardian, registration number and custom fields. Use it to push profile changes from your own system into Edmingle.
POST
/organization/students/{user_id}Update Student Info
curl --request POST \
--url 'https://<your-api-host>/nuSource/api/v1/organization/students/{user_id}' \
--header 'APIKEY: <your-api-key>' \
--header 'ORGID: <your-org-id>' \
--form 'JSONString={"external_uuid":"6880895a2ad4e601c26cd9f3","name":"sake","user_username":"sake5352535","gender":"","religion":0,"contact_number":"9908607678","contact_number_country_id":103,"contact_number_dial_code":"+91","contact_number_2":null,"contact_number_2_dial_code":"+91","contact_number_2_country_id":103,"email":"shaik@gmail.com","alternate_email":null,"landline":null,"address":null,"city":"gsi","state":"0","pincode":null,"residential_address":null,"u_parent_name":"hsi","u_parent_email":"saeunxkth@gmail.com","u_parent_contact":"","u_parent_contact_country_id":103,"standard":0,"qualification":0,"occupation":0,"school":"0","registration_number":"784","ed_background":"[{\"qualification\":\"\",\"yop\":\"\",\"institution\":\"\"}]","aadhaar_number":null,"document_name":[],"organization_id":329,"cf_1":"","cf_2":"","cf_3":"","cf_4":"","cf_5":"","custom_fields":[{"field_id":234163,"organization_id":329,"field_display_name":"Text | online Pre","field_help_text":"","field_type":1,"default_value":"","possible_values":"[]","field_name":"text_|_online_pre","original_form_type":1,"field_value":"","form_field_mapper_id":244654,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":1,"is_online_mandatory":1,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":37},{"field_id":234162,"organization_id":329,"field_display_name":"Text | Post man","field_help_text":"","field_type":1,"default_value":"","possible_values":"[]","field_name":"text_|_post_man","original_form_type":1,"field_value":"sdfds","form_field_mapper_id":244653,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":1,"is_online_mandatory":1,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":48},{"field_id":217067,"organization_id":329,"field_display_name":"File Upload demo","field_help_text":"","field_type":5,"default_value":"","possible_values":"[]","field_name":"file_upload_demo","original_form_type":1,"field_value":"","form_field_mapper_id":227807,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":0,"is_online_mandatory":0,"show_offline":1,"is_offline_mandatory":0,"is_active":1,"display_index":59},{"field_id":58272,"organization_id":329,"field_display_name":"File Upload","field_help_text":"","field_type":5,"default_value":"","possible_values":"[]","field_name":"file_upload","original_form_type":1,"field_value":"","form_field_mapper_id":71291,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":0,"is_online_mandatory":0,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":63},{"field_id":58269,"organization_id":329,"field_display_name":"Just Some Num Fields","field_help_text":"","field_type":2,"default_value":"","possible_values":"[]","field_name":"number_field","original_form_type":1,"field_value":"","form_field_mapper_id":71288,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":0,"is_online_mandatory":0,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":68},{"field_id":195951,"organization_id":329,"field_display_name":"test11","field_help_text":"","field_type":1,"default_value":"","possible_values":"[]","field_name":"test11","original_form_type":1,"field_value":"","form_field_mapper_id":207065,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":0,"is_online_mandatory":0,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":69},{"field_id":234164,"organization_id":329,"field_display_name":"Text | Online Post","field_help_text":"","field_type":1,"default_value":"","possible_values":"[]","field_name":"text_|_online_post","original_form_type":1,"field_value":"","form_field_mapper_id":244655,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":0,"is_online_mandatory":0,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":91},{"field_id":214629,"organization_id":329,"field_display_name":"Occupation t","field_help_text":"","field_type":1,"default_value":"","possible_values":"[]","field_name":"occupation_t","original_form_type":1,"field_value":"","form_field_mapper_id":225413,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":1,"is_online_mandatory":1,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":92},{"field_id":26597,"organization_id":329,"field_display_name":"Mother'\''s Name","field_help_text":"","field_type":1,"default_value":"","possible_values":"[]","field_name":"mother'\''s_name","original_form_type":1,"field_value":"asdsasdsf","form_field_mapper_id":38990,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":1,"is_online_mandatory":0,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":99},{"field_id":58270,"organization_id":329,"field_display_name":"Select field123","field_help_text":"","field_type":3,"default_value":"","possible_values":"[{\"name\":\"opt 1\",\"value\":1,\"status\":1},{\"name\":\"opt 2\",\"value\":2,\"status\":1},{\"name\":\"opt va\",\"value\":3,\"status\":1}]","field_name":"select_field","original_form_type":1,"field_value":"","form_field_mapper_id":71289,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":0,"is_online_mandatory":0,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":102},{"field_id":330440,"organization_id":329,"field_display_name":"Mobile","field_help_text":"Select","field_type":3,"default_value":"","possible_values":[{"name":"Oneplus","value":1,"status":1},{"name":"Iphone","value":2,"status":1},{"name":"Samsung","value":3,"status":1}],"field_name":"mobile","original_form_type":1,"field_value":"","form_field_mapper_id":340258,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":1,"is_online_mandatory":0,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":103},{"field_id":331829,"organization_id":329,"field_display_name":"testing signup","field_help_text":"","field_type":3,"default_value":"","possible_values":"[]","field_name":"testing_signup","original_form_type":1,"field_value":"","form_field_mapper_id":341625,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":0,"is_online_mandatory":0,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":125},{"field_id":58271,"organization_id":329,"field_display_name":"Date field","field_help_text":"","field_type":4,"default_value":"","possible_values":"[]","field_name":"date_field","original_form_type":1,"field_value":1681151400,"form_field_mapper_id":71290,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":1,"is_online_mandatory":2,"show_offline":0,"is_offline_mandatory":0,"is_active":1,"display_index":130},{"field_id":332145,"organization_id":329,"field_display_name":"My City","field_help_text":"","field_type":1,"default_value":"","possible_values":"[]","field_name":"my_city","original_form_type":1,"field_value":"","form_field_mapper_id":341936,"form_type":1,"system_field_setting":0,"section_id":1,"show_online":1,"is_online_mandatory":0,"show_offline":1,"is_offline_mandatory":0,"is_active":1,"display_index":136}],"area":0,"source":1,"timezone":"(UTC+05:30) Asia/Calcutta"}'{
"code": 200,
"message": "Success"
}Access: Institute admins, plus custom roles that can manage learners.
Path parameters
ID of the learner, e.g.
organization/students/43974.Request body: form-data with one field, JSONString, containing this JSON. File-type custom fields and documents can be attached as extra form-data parts (JPEG, PNG, GIF or PDF, up to 5 MB).
Body
JSONStringEmail.
Mobile number.
contact_number_country_idinteger
Country of
contact_number (country_code_id from "Countries List"). Default 103 (India).namestring
Full name. Letters, spaces, apostrophes and dots only.
user_usernamestring
Username, up to 50 characters. Must be unique.
registration_numberstring
Registration number in the organization given by
organization_id.organization_idinteger
Organization whose registration number to set. Defaults to your
ORGID organization.contact_number_2string
Second mobile number.
contact_number_2_country_idinteger
Country of
contact_number_2. Default 103.first_name, last_namestring
Name parts.
genderinteger
0 not specified, 1 male, 2 female.birthdayUnix timestamp
Date of birth.
Address and school details.
stateinteger
State ID from the list of Indian states. Any other value is rejected.
u_parent_namestring
Guardian name. Required if you send a guardian email or phone. Creates the guardian account if the learner has none.
Guardian email and mobile number.
u_parent_contact_country_idinteger
Country of
u_parent_contact.Other profile details.
external_uuidstring
Your own ID for the learner. Must be unique in your institute.
cf_1 ... cf_5string
The five spare profile fields.
languagestring
Interface language code. Default
en.timezonestring
Time zone offset. Defaults to India time.
custom_fieldsarray
Custom field values: objects with
field_id, field_value and field_type (1 text, 2 number, 3 dropdown, 4 date, 5 file upload). For file fields, attach the file as a form-data part.institution_idinteger
Your institute ID. Defaults to the institute of your
ORGID organization.Notes:
- This overwrites the profile. Fields you leave out are not all kept:
email,contact_number,contact_number_2, the guardian email and phone,birthday,registration_number,standard,cf_1tocf_5,language,timezoneandcountryare cleared or reset to defaults when missing. Read the learner first ("Retrieve a Student") and send every field back. - Errors: "Invalid user ID" (you or the learner are not in that institute), "Please provide at least one contact information", "Please enter a valid primary mobile number.", "Please provide parent name", "Username already exists", "Please select a state from the given options.".
- Triggers the institute's profile-edit and user-updated webhooks.
- Rate limit: 30 requests per minute; going over locks you out for 30 minutes.