Update a user

Authorization

ApiKeyAuth

x-api-key<token>

API key created in CourseLit dashboard settings. The legacy apikey request-body field is still accepted but deprecated.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

apikey?stringDeprecated

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

email*string

Email address of the user to update.

Formatemail

name?string

Updated display name for the user.

permissions?array<>

Updated permissions for the user.

subscribedToUpdates?boolean

Updated marketing subscription preference for the user.

Response Body

`application/json`

curl -X PATCH "https://school.courselit.app/api/user" \  -H "Content-Type: application/json" \  -d '{    "email": "student@example.com",    "name": "Updated Student",    "subscribedToUpdates": false  }'

{
  "email": "5d41402abc4b2a76b9719d911017c592"
}

{
  "message": "Bad request"
}

{
  "message": "Unauthorized"
}

{
  "error": "User not found"
}

{
  "error": "Internal server error"
}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`