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

# Generate a PDF from a custom template

POST https://ssuccessv2.com/app/api/v1/custom-document-templates/{id}/generate-pdf
Content-Type: application/json

Generates one or more documents for selected school entities. A single PDF returns a temporary file descriptor; ZIP output or more than ten entities is queued and returns a background-job descriptor.

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

## Authentication

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

## Request

### Path parameters

- `id` (integer, required) — Custom document template ID.

### Body (application/json)

This endpoint expects an object.

- `entity_type` (string, required)
- `entity_id` (integer, optional)
- `entity_ids` (list of integer, optional)
- `node_ids` (list of integer, optional)
- `class_ids` (list of integer, optional)
- `excluded_node_ids` (list of integer, optional)
- `excluded_class_ids` (list of integer, optional)
- `excluded_entity_ids` (list of integer, optional)
- `output_type` (enum, optional)
  - Allowed values: `single`, `zip`
- `academic_year_id` (integer, optional)

## Response

### 200

PDF descriptor or queued-generation descriptor.

- `status` (string, required)
- `message` (string, required)
- `data` (map from string to any, required)

## Errors

### 401 Unauthorized Error

Authentication required.

- `any`

### 403 Forbidden Error

The user cannot view this template type.

- `any`

### 404 Not Found Error

Template or selected record not found.

- `any`

### 422 Unprocessable Entity Error

- `any`

### 502 Bad Gateway Error

- `any`

## Examples

### file

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": {
    "id": 9001,
    "url": "https://files.schoolset.test/tmp/9001",
    "file_mime_type": "application/pdf",
    "file_original_name": "re-enrollment-notice-students-2048-2051.pdf"
  }
}
```

**SDK Code**

```python file
import requests

url = "https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript file
const url = 'https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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

```go file
package main

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

func main() {

	url := "https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

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

url = URI("https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

HttpResponse<String> response = Unirest.post("https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp file
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift file
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

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()
```

### queued

**Response**

```json
{
  "status": "success",
  "message": "Poster generation has started. You will receive a notification when it is ready.",
  "data": {
    "background": true,
    "template_id": 42,
    "entity_ids": [
      2048,
      2051
    ],
    "entity_type": "student",
    "output_type": "zip"
  }
}
```

**SDK Code**

```python queued
import requests

url = "https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript queued
const url = 'https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

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

```go queued
package main

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

func main() {

	url := "https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

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

}
```

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

url = URI("https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

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

HttpResponse<String> response = Unirest.post("https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp queued
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift queued
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

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()
```

### Custom document templates_generateCustomDocumentTemplatePdf_example

**Request**

```json
{
  "entity_type": "student",
  "entity_ids": [
    2048,
    2051
  ],
  "output_type": "single",
  "academic_year_id": 2026
}
```

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": {
    "id": 9001,
    "url": "https://files.schoolset.test/tmp/9001",
    "file_mime_type": "application/pdf",
    "file_original_name": "re-enrollment-notice-students-2048-2051.pdf"
  }
}
```

**SDK Code**

```python Custom document templates_generateCustomDocumentTemplatePdf_example
import requests

url = "https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf"

payload = {
    "entity_type": "student",
    "entity_ids": [2048, 2051],
    "output_type": "single",
    "academic_year_id": 2026
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Custom document templates_generateCustomDocumentTemplatePdf_example
const url = 'https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"entity_type":"student","entity_ids":[2048,2051],"output_type":"single","academic_year_id":2026}'
};

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

```go Custom document templates_generateCustomDocumentTemplatePdf_example
package main

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

func main() {

	url := "https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf"

	payload := strings.NewReader("{\n  \"entity_type\": \"student\",\n  \"entity_ids\": [\n    2048,\n    2051\n  ],\n  \"output_type\": \"single\",\n  \"academic_year_id\": 2026\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 Custom document templates_generateCustomDocumentTemplatePdf_example
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf")

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  \"entity_type\": \"student\",\n  \"entity_ids\": [\n    2048,\n    2051\n  ],\n  \"output_type\": \"single\",\n  \"academic_year_id\": 2026\n}"

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

```java Custom document templates_generateCustomDocumentTemplatePdf_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity_type\": \"student\",\n  \"entity_ids\": [\n    2048,\n    2051\n  ],\n  \"output_type\": \"single\",\n  \"academic_year_id\": 2026\n}")
  .asString();
```

```php Custom document templates_generateCustomDocumentTemplatePdf_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf', [
  'body' => '{
  "entity_type": "student",
  "entity_ids": [
    2048,
    2051
  ],
  "output_type": "single",
  "academic_year_id": 2026
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp Custom document templates_generateCustomDocumentTemplatePdf_example
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"entity_type\": \"student\",\n  \"entity_ids\": [\n    2048,\n    2051\n  ],\n  \"output_type\": \"single\",\n  \"academic_year_id\": 2026\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Custom document templates_generateCustomDocumentTemplatePdf_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "entity_type": "student",
  "entity_ids": [2048, 2051],
  "output_type": "single",
  "academic_year_id": 2026
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/custom-document-templates/42/generate-pdf")! 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()
```