Update a student

PATCH

https://ssuccessv2.com/app/api/v2/student/update/:id

Updates a student and its family, academic-year placement, class or grade relation, and addresses in the active school. The complete validated student form and address array are required; the saved v2 student resource is returned.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Path parameters

idintegerRequired

Request

This endpoint expects an object.

firstnamestringRequired

lastnamestringRequired

addresslist of maps from strings to anyRequired

family_idintegerRequired

academ_year_idintegerRequired

firstname_hebrewstring or nullOptional

lastname_hebrewstring or nullOptional

phonestring or nullOptional

emailstring or nullOptionalformat: "email"

dobdate or nullOptional

dob_hebrewstring or nullOptional

genderenumOptional

Allowed values:

class_idinteger or nullOptional

grade_idinteger or nullOptional

Response

Student updated and returned as a v2 student resource.

statusstring

messagestring

datamap from strings to any

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X PATCH https://ssuccessv2.com/app/api/v2/student/update/241 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"firstname": "string",
>	"lastname": "string",
>	"address": [
>	{}
>	],
>	"family_id": 1,
>	"academ_year_id": 1
>	}'