Create or update a family

POST

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

Creates a family and its supplied address, parents, students, relatives, and emergency contacts, or updates an existing family by id.

AuthorizationBearer

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

This endpoint expects an object.

idinteger or nullOptional

family_namestringOptional

home_phonestringOptional

lastname_hebrewstringOptional

processing_fee_blockedbooleanOptional

addressobject or nullOptional

parentslist of objectsOptional

studentslist of objectsOptional

relativeslist of objectsOptional

contactslist of objectsOptional

The family was created or updated and the family resource was returned.

statusstringOptional

messagestringOptional

dataobjectOptional

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error

$	curl -X POST https://ssuccessv2.com/app/api/v2/family/create \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"family_name": "Cohen Family",
>	"home_phone": "+1-212-555-0199",
>	"parents": [
>	{
>	"firstname": "David",
>	"lastname": "Cohen",
>	"email": "david@schoolset.example"
>	}
>	],
>	"students": [
>	{
>	"firstname": "Leah",
>	"lastname": "Cohen",
>	"dob": {},
>	"gender": "female"
>	}
>	]
>	}'

1	{
2	"status": "success",
3	"message": "Family created successfully.",
4	"data": {
5	"id": 284,
6	"family_name": "Cohen Family",
7	"parents": [
8	{}
9	],
10	"students": [
11	{}
12	]
13	}
14	}