Create a student

POST

https://ssuccessv2.com/app/api/v2/student/create

Creates a student in the active school, associates the supplied family and academic year, optionally places the student in a class or grade, creates each supplied address, and returns the v2 student resource. Creating students requires create-students permission.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

firstnamestringRequired

lastnamestringRequired

addresslist of objectsRequired

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 created and returned as a v2 student resource.

statusstring

messagestring

datamap from strings to any

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v2/student/create \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"firstname": "Sarah",
>	"lastname": "Cohen",
>	"address": [
>	{
>	"splitted": {
>	"city": "New York",
>	"state": "NY",
>	"zip": "10001"
>	},
>	"components": {},
>	"formatted": "1 Main St, New York, NY",
>	"longitude": -73.99,
>	"latitude": 40.75,
>	"tag": "home"
>	}
>	],
>	"family_id": 41,
>	"academ_year_id": 9,
>	"email": "sarah.cohen@example.com",
>	"dob": "2023-01-15",
>	"gender": "female",
>	"grade_id": 3
>	}'

1	{
2	"status": "success",
3	"message": "Saved successfully.",
4	"data": {}
5	}