Sign in
Users

Update a user

Updates a user in the current school. Call this endpoint on the school domain, for example https://school.courselit.app/api/user, and authenticate with x-api-key. CourseLit proxy infrastructure resolves the school and injects the internal domain header automatically. The legacy apikey field in the request body is still accepted for backward compatibility.

patch/api/user

Request body

apikeystring

Deprecated legacy API key transport. Prefer the x-api-key header.

emailstring email required

Email address of the user to update.

namestring

Updated display name for the user.

permissionsstring[]

Updated permissions for the user.

subscribedToUpdatesboolean

Updated marketing subscription preference for the user.

Response

User updated successfully.

emailstring required

MD5 hash of the user email.

Example response

{
  "email": "5d41402abc4b2a76b9719d911017c592"
}

Changes