Merge one family into another

POST

https://ssuccessv2.com/app/api/v1/families/merge

POST

/app/api/v1/families/merge

$ curl -X POST https://ssuccessv2.com/app/api/v1/families/merge \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "target_family_student_id": 1842,
>   "source_family_student_id": 1976,
>   "profile_from": "target",
>   "selection": {
>     "student_plans": [
>       {
>         "source_student_id": 3210,
>         "action": "move"
>       }
>     ],
>     "parent_ids": [
>       4401
>     ],
>     "contract_ids": [
>       812
>     ]
>   }
> }'

1 {
2   "status": "success",
3   "message": "Families merged successfully.",
4   "data": {
5     "merge_uuid": "4f1e6f8f-0ac9-4d8d-a2d3-6d0d02b8b1a0",
6     "merge_event_id": 72,
7     "target_family_student_id": 1842,
8     "source_family_student_id": 1976,
9     "family": {
10       "id": 1842,
11       "name": "Garcia Family"
12     }
13   }
14 }

Merges the source family into the target family using the selected profile, people, contracts, and payment records. The target family remains after a successful merge.

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.

target_family_student_idintegerRequired>=1

source_family_student_idintegerRequired>=1

profile_fromenumOptional

Allowed values:

family_profile_field_sourcesmap from strings to enumsOptional

Allowed values:

selectionobjectOptional

Response

Family merged successfully.

statusstring

messagestring

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error