Link a submission to a person

PUT

https://ssuccessv2.com/app/api/v1/forms/submissions/:formSubmission/person

PUT

/app/api/v1/forms/submissions/:formSubmission/person

$ curl -X PUT https://ssuccessv2.com/app/api/v1/forms/submissions/901/person \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "payer_id": 118,
>   "payer_type": "parent"
> }'

1 {
2   "status": "success",
3   "message": "Updated successfully.",
4   "data": {
5     "id": 901,
6     "form_data": {
7       "student_name": "Ava Lee"
8     },
9     "reference_hash": "8pJ3zYx1mN7qR4sT",
10     "is_spam": false,
11     "imported": false,
12     "created_at": "August 20",
13     "payment_id": null,
14     "payment_recurring_id": null,
15     "submitter_name": "Ava Lee",
16     "completed_documents": [],
17     "payment": null,
18     "payer": {
19       "full_name": "Jordan Lee",
20       "email": "jordan.lee@example.test",
21       "phone": "+1 212 555 0100"
22     },
23     "workflow_current_stage": null,
24     "2026 10:15 AM": null
25   }
26 }

Links an unlinked submission to a parent, entity, or donor. The server also links applicable fees, payments, and uploaded files; attempting to link an already-linked submission returns a validation error.

Authentication

AuthorizationBearer

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

Path parameters

formSubmissionlongRequired>=1

Submission to link.

Request

This endpoint expects an object.

payer_idlongRequired>=1

ID of the parent

payer_typeenumRequired

Payer model category.

Allowed values:

Response

The submission was linked and the updated submission resource is returned.

statusenum

messagestring

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error