Update a student's profile

PATCH /api/students/{id}. Update a student's profile. Headless LMS Organizations API reference.

Path Parameters

id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

firstName*string

Length1 <= length

lastName*string

Length1 <= length

email*string

Match

^[a-zA-Z0-9.!#$%&'*+/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*$

Formatemail

Response Body

`application/json`

curl -X PATCH "https://example.com/api/students/string" \  -H "Content-Type: application/json" \  -d '{    "firstName": "string",    "lastName": "string",    "email": "user@example.com"  }'

{  "id": "string",  "firstName": "string",  "lastName": "string",  "email": "string",  "image": "string",  "entitlementCount": -9007199254740991,  "avgProgress": -9007199254740991,  "status": "invited",  "joinedAt": "string",  "lastActiveAt": "string"}

{  "error": "string",  "message": "string",  "requestId": "string"}

{  "error": "string",  "message": "string",  "requestId": "string"}

Update a student's profile

Path Parameters

Request Body

Response Body

200application/json

404application/json

409application/json

`application/json`

`application/json`

`application/json`