> 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.

# Register an uploaded PDF as a template

POST https://ssuccessv2.com/app/api/v1/document-templates/upload
Content-Type: application/json

Associates an already-uploaded PDF file-manager record with a new document template and queues field detection for the active school.

Reference: https://docs.schoolset.io/api-reference/school-set-api/document-templates/upload-document-template

## Authentication

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

## Request

### Body (application/json)

This endpoint expects an object.

- `file_manager_id` (integer, required) — Uploaded PDF file-manager identifier.
- `name` (string, required)
- `entity_type` (enum, required)
  - Allowed values: `family`, `parent`, `student`, `entity`, `staff`, `donor`
- `description` (string, optional, nullable)

## Response

### 200

Template created and returned.

## Errors

### 422 Unprocessable Entity Error

Upload metadata failed validation or the source PDF could not be processed.

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

### 500 Internal Server Error

The template could not be created.

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

## Examples

**Request**

```json
{
  "file_manager_id": 781,
  "name": "Emergency Contact Form",
  "entity_type": "student",
  "description": "Annual emergency contact information form"
}
```

**Response**

```json
{
  "status": "success",
  "message": "Document uploaded successfully.",
  "data": {
    "id": 42,
    "name": "Emergency Contact Form",
    "description": "Annual emergency contact information form",
    "entity_type": "student",
    "created_at": {},
    "updated_at": {},
    "file": {
      "id": 781,
      "file_hash": "6d1f4e8a9c2b",
      "file_name": "emergency-contact-form.pdf",
      "file_original_name": "Emergency Contact Form.pdf",
      "file_mime_type": "application/pdf",
      "caption": "Emergency Contact Form",
      "file_size": 184320,
      "created_at": {},
      "updated_at": {}
    },
    "field_scan": null
  }
}
```

**SDK Code**

```python Document templates_uploadDocumentTemplate_example
import requests

url = "https://ssuccessv2.com/app/api/v1/document-templates/upload"

payload = {
    "file_manager_id": 781,
    "name": "Emergency Contact Form",
    "entity_type": "student",
    "description": "Annual emergency contact information form"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Document templates_uploadDocumentTemplate_example
const url = 'https://ssuccessv2.com/app/api/v1/document-templates/upload';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"file_manager_id":781,"name":"Emergency Contact Form","entity_type":"student","description":"Annual emergency contact information form"}'
};

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

```go Document templates_uploadDocumentTemplate_example
package main

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

func main() {

	url := "https://ssuccessv2.com/app/api/v1/document-templates/upload"

	payload := strings.NewReader("{\n  \"file_manager_id\": 781,\n  \"name\": \"Emergency Contact Form\",\n  \"entity_type\": \"student\",\n  \"description\": \"Annual emergency contact information form\"\n}")

	req, _ := http.NewRequest("POST", 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 Document templates_uploadDocumentTemplate_example
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/document-templates/upload")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_manager_id\": 781,\n  \"name\": \"Emergency Contact Form\",\n  \"entity_type\": \"student\",\n  \"description\": \"Annual emergency contact information form\"\n}"

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

```java Document templates_uploadDocumentTemplate_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://ssuccessv2.com/app/api/v1/document-templates/upload")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_manager_id\": 781,\n  \"name\": \"Emergency Contact Form\",\n  \"entity_type\": \"student\",\n  \"description\": \"Annual emergency contact information form\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/document-templates/upload', [
  'body' => '{
  "file_manager_id": 781,
  "name": "Emergency Contact Form",
  "entity_type": "student",
  "description": "Annual emergency contact information form"
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Document templates_uploadDocumentTemplate_example
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/document-templates/upload");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"file_manager_id\": 781,\n  \"name\": \"Emergency Contact Form\",\n  \"entity_type\": \"student\",\n  \"description\": \"Annual emergency contact information form\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Document templates_uploadDocumentTemplate_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "file_manager_id": 781,
  "name": "Emergency Contact Form",
  "entity_type": "student",
  "description": "Annual emergency contact information form"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/document-templates/upload")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
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()
```