[BETA] Partially update a student by ID

Partially update a student addressed by its Edusign id.

Only provided fields are modified.

  • If a field is set to null → its value is reset.
  • If a field is not provided → partial update, the field is ignored.

Groups are never modified: this route does not read nor write the student's groups, trainings or course enrolments, whatever the body carries. Unknown fields are ignored.

meta.updatedFields lists the fields whose stored value actually changed. A body that repeats the stored values changes nothing: updatedFields is empty and no on_student_edited webhook is sent.

email is the sign-in identifier of the student: changing it changes how they sign in. It must be unique among the active students of your school (409 STUDENT_ALREADY_EXISTS); the same email in another school is allowed (multi-account).

companyId and company are unrelated. companyId attaches the student to a shared company record of your school (see the Companies endpoints); company is the historical free-text company name. Setting one never reads nor writes the other. A companyId that does not name a company of YOUR school answers 400 STUDENT_COMPANY_NOT_FOUND.

An unknown id, or one belonging to another school, answers 404 STUDENT_NOT_FOUND.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≥ 1

Edusign student identifier

Body Params
string
length between 1 and 100

First name. Max 100 characters. Cannot be cleared.

string
length between 1 and 100

Last name. Max 100 characters. Cannot be cleared.

Email address, also the sign-in identifier of the student. Max 128 characters. Must be unique among the active students of your school.

length ≤ 20

Phone number. Max 20 characters.

length ≤ 255

URL of the student photo. Max 255 characters.

length ≤ 128

Student file number or reference. Max 128 characters.

length ≤ 160

Name of the curriculum program. Max 160 characters.

length ≤ 64

Historical free-text company name stored on the student. Max 64 characters. Unrelated to companyId: it does not create, attach nor update a company record.

^[0-9A-HJKMNP-TV-Za-hjkmnp-tv-z]{26}$

Identifier (ULID) of a shared company record of YOUR school to attach the student to; null detaches them. Unrelated to the free-text company field, which is never read nor written by this field.

array | null

Custom tags, replacing the whole list. Max 15 tags, each max 35 characters.

string
enum

Preferred language of the student. Cannot be cleared.

Allowed:
length ≤ 128

Your system's unique identifier for this student. Max 128 characters. Must be unique within your school.

length ≤ 30

The name of the third-party system that owns the student's external reference. Max 30 characters.

length ≤ 20

NFC Edusign badge ID assigned to the student. Max 20 characters.

Responses

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json