[BETA] Update a person outside the school

Partial update of an existing record by its 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.

An unknown id, or one belonging to another school, answers 404 EXTERNAL_NOT_FOUND — never a silent success.

The email and the external reference are only checked for conflicts when they actually CHANGE: re-sending the record’s own values never fails, whatever duplicates the school already holds. A new address held by an ACTIVE record answers 409 EXTERNAL_ALREADY_EXISTS; one held only by an ARCHIVED record answers 409 EXTERNAL_ARCHIVED_EXISTS, both with the holder’s id under errors[0].context.existingExternalId.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 1 and 40
Body Params
string
length between 1 and 30
string
length between 1 and 30
string
length between 1 and 20

If a field is set to null → its value is reset.

length between 1 and 36

If a field is set to null → its value is reset.

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

If a field is set to null → its value is reset.

length between 1 and 128

If a field is set to null → its value is reset, along with its type.

length between 1 and 30
Responses

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