> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.schoolset.io/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.schoolset.io/_mcp/server.

# Link a submission to a person

PUT https://ssuccessv2.com/app/api/v1/forms/submissions/{formSubmission}/person
Content-Type: application/json

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.

Reference: https://docs.schoolset.io/api-reference/school-set-api/forms/link-form-submission-person

## Authentication

- `Authorization` header (bearer token, required) — The signed-in SchoolSet user token sent by the frontend.

## Request

### Path parameters

- `formSubmission` (long, required) — Submission to link.

### Body (application/json)

This endpoint expects an object.

- `payer_id` (long, required) — ID of the parent
- `payer_type` (enum, required) — Payer model category.
  - Allowed values: `parent`, `entity`, `donor`

## Response

### 200

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

- `status` (enum, required)
  - Allowed values: `success`
- `message` (string, required)
- `data` (ApiV1FormsSubmissionsFormSubmissionPersonPutResponsesContentApplicationJsonSchemaData, required)

## Errors

### 401 Unauthorized Error

The access token is missing or invalid.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 403 Forbidden Error

The user lacks edit-forms permission.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 404 Not Found Error

The submission or payer does not exist in the active school.

- `status` (string, required)
- `message` (string, required)
- `data` (any, optional, nullable)

### 422 Unprocessable Entity Error

The payload is invalid or the submission is already linked to a person.

- `message` (string, required)
- `errors` (map from string to list of string, required)

## Types

### ApiV1FormsSubmissionsFormSubmissionPersonPutResponsesContentApplicationJsonSchemaData

- `id` (integer, required)
- `form_data` (map from string to any, required)
- `reference_hash` (string, required, nullable)
- `is_spam` (boolean, required)
- `imported` (boolean, required)
- `created_at` (string, optional, nullable)
- `payment_id` (integer, optional, nullable)
- `payment_recurring_id` (integer, optional, nullable)
- `submitter_name` (string, optional, nullable)
- `completed_documents` (list of map from string to any, optional)
- `payment` (map from string to any, optional, nullable)
- `payer` (map from string to any, optional, nullable)
- `workflow_current_stage` (map from string to any, optional, nullable)

## Examples

**Request**

```json
{
  "payer_id": 118,
  "payer_type": "parent"
}
```

**Response**

```json
{
  "status": "success",
  "message": "Updated successfully.",
  "data": {
    "id": 901,
    "form_data": {
      "student_name": "Ava Lee"
    },
    "reference_hash": "8pJ3zYx1mN7qR4sT",
    "is_spam": false,
    "imported": false,
    "created_at": "August 20",
    "payment_id": null,
    "payment_recurring_id": null,
    "submitter_name": "Ava Lee",
    "completed_documents": [],
    "payment": null,
    "payer": {
      "full_name": "Jordan Lee",
      "email": "jordan.lee@example.test",
      "phone": "+1 212 555 0100"
    },
    "workflow_current_stage": null,
    "2026 10:15 AM": null
  }
}
```

**SDK Code**

```python Forms_linkFormSubmissionPerson_example
import requests

url = "https://ssuccessv2.com/app/api/v1/forms/submissions/901/person"

payload = {
    "payer_id": 118,
    "payer_type": "parent"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.json())
```

```javascript Forms_linkFormSubmissionPerson_example
const url = 'https://ssuccessv2.com/app/api/v1/forms/submissions/901/person';
const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"payer_id":118,"payer_type":"parent"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Forms_linkFormSubmissionPerson_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ssuccessv2.com/app/api/v1/forms/submissions/901/person"

	payload := strings.NewReader("{\n  \"payer_id\": 118,\n  \"payer_type\": \"parent\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Forms_linkFormSubmissionPerson_example
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/forms/submissions/901/person")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"payer_id\": 118,\n  \"payer_type\": \"parent\"\n}"

response = http.request(request)
puts response.read_body
```

```java Forms_linkFormSubmissionPerson_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.put("https://ssuccessv2.com/app/api/v1/forms/submissions/901/person")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"payer_id\": 118,\n  \"payer_type\": \"parent\"\n}")
  .asString();
```

```php Forms_linkFormSubmissionPerson_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PUT', 'https://ssuccessv2.com/app/api/v1/forms/submissions/901/person', [
  'body' => '{
  "payer_id": 118,
  "payer_type": "parent"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Forms_linkFormSubmissionPerson_example
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/forms/submissions/901/person");
var request = new RestRequest(Method.PUT);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"payer_id\": 118,\n  \"payer_type\": \"parent\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Forms_linkFormSubmissionPerson_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "payer_id": 118,
  "payer_type": "parent"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/forms/submissions/901/person")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PUT"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```