Create a family

POST

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

POST

/app/api/v1/family/create

$ curl -X POST https://ssuccessv2.com/app/api/v1/family/create \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "name": "Cohen Family",
>   "lastname_hebrew": "כהן",
>   "description": "Family created during enrollment",
>   "processing_fee_blocked": false
> }'

1 {
2   "status": "success",
3   "message": "Saved successfully.",
4   "data": {
5     "id": 2481,
6     "name": "Cohen Family",
7     "lastname": null,
8     "lastname_hebrew": "כהן",
9     "home_phone": null,
10     "cell_phone": null,
11     "email": null,
12     "description": "Family created during enrollment",
13     "processing_fee_blocked": false,
14     "is_processing_fee_blocked": false,
15     "parents": [],
16     "students": [],
17     "relatives": [],
18     "emergency_contacts": [],
19     "addresses": []
20   }
21 }

Creates a family record for the active school and returns the newly created family.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

namestring or nullOptional<=255 characters

lastname_hebrewstring or nullOptional<=255 characters

descriptionstring or nullOptional<=1000 characters

processing_fee_blockedboolean or nullOptional

Response

Family created.

statusstringOptional

messagestringOptional

datamap from strings to anyOptional

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error