[BETA] Update a school user

Updates the name, email, phone, role or photo of a school user (an administrator or collaborator account) in place, so the account keeps its history. Only the fields sent are changed; at least one is required. Re-sending the current values of name, email, phone and role succeeds with an empty updatedFields; photoUrl is the exception: a URL sent is always processed again (the image behind it may have changed) and is then listed. The user is looked up in the API key's school: a user of another school, or a deleted one, answers 404 USER_NOT_FOUND (list the ids with GET /v1/users).

Permission: the API key needs the update level on users, as POST /v1/users does; an OAuth token cannot use this endpoint (403).

Email: unique among the users of the school, compared ignoring case (409 USER_ALREADY_EXISTS); the same address in another school is allowed, that is how one person holds accounts in several schools. An effective change locks the account until the owner of the new address activates it: the password is cleared, every session is closed and the new-collaborator invitation is sent to the new address, following the school's invitation setting. Nothing is sent to the old address. The same address in another case or with surrounding spaces is a no-op.

Role: ANALYST, USER or ADMIN, never OWNER. A change applies on the user's next request; leaving the USER role clears the group restriction and its audience type.

Photo: photoUrl is downloaded, checked, scanned for viruses, resized and stored by Edusign after the response, like student photos; a failure (unreachable URL, not an image, infected file) leaves the current photo unchanged without changing the response. photoUrl: null removes the photo at once.

The owner: any request on the owner account answers 422 USER_OWNER_EDIT_NOT_ALLOWED and saves nothing, whatever the values sent, as on the platform where only the owner edits it; integrations must skip the owner. Ownership transfer stays a support operation.

This endpoint supersedes POST /v1/users/change-permissions, which stays live. There is no by-reference-id route: school users have no external reference today.

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

Internal Edusign ID of the school user (ACCOUNTS.ID), as GET /v1/users returns it. School users carry no external reference, so there is no by-reference-id route. 1 to 20 characters, not blank: a blank or longer value is rejected with 400 VALIDATION_ERROR naming the id.

Body Params
string
length between 1 and 90

Full name, 1 to 90 characters, stored as sent (no capitalisation). Absent: unchanged.

string
length ≤ 128
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Sign-in email, at most 128 characters, unique among the users of the school (compared ignoring case; the same address in another school is allowed). An effective change locks the account until the owner of the new address activates it through the invitation sent there: the password is cleared and every session is closed. The same address in another case is a no-op. Absent: unchanged.

length ≤ 20

Phone, at most 20 characters. If set to null → its value is reset. Absent: unchanged.

string
enum

Role in this school: ANALYST, USER or ADMIN (never OWNER). A change applies on the user's next request; leaving the USER role clears the group restriction and its audience type. Absent: unchanged.

Allowed:
length ≤ 255

Absolute http(s) URL of the photo, at most 255 characters. The image is downloaded, checked, scanned, resized and stored by Edusign after the response; a failure leaves the current photo unchanged. If set to null → the photo is removed at once. Absent: unchanged.

Responses

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