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

# Save a list-label template

POST https://ssuccessv2.com/app/api/v1/save-template
Content-Type: application/json

Creates or updates a saved list-label template for an academic year.

Reference: https://docs.schoolset.io/api-reference/school-set-api/list-labels/save-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.

- `name` (string, required)
- `template_type_id` (integer, required)
- `academic_year_id` (integer, required)
- `payload` (map from string to any, required)
- `id` (integer, optional, nullable)
- `description` (string, optional)
- `public` (boolean, optional)
- `mode` (enum, optional)
  - Allowed values: `check`, `overwrite`

## Response

### 200

The template was saved and its stored fields were returned.

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

## Errors

### 401 Unauthorized Error

Authentication is required.

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

### 409 Conflict Error

A public template already exists for that academic year.

- `status` (string, optional)
- `message` (string, optional)

## Examples

**Request**

```json
{
  "name": "Mailing Labels",
  "template_type_id": 1,
  "academic_year_id": 2025,
  "payload": {
    "filters": {},
    "columns": [],
    "layout": {}
  }
}
```

**Response**

```json
{
  "status": "success",
  "message": "Template saved successfully",
  "data": {}
}
```

**SDK Code**

```python
import requests

url = "https://ssuccessv2.com/app/api/v1/save-template"

payload = {
    "name": "Mailing Labels",
    "template_type_id": 1,
    "academic_year_id": 2025,
    "payload": {
        "filters": {},
        "columns": [],
        "layout": {}
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript
const url = 'https://ssuccessv2.com/app/api/v1/save-template';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"name":"Mailing Labels","template_type_id":1,"academic_year_id":2025,"payload":{"filters":{},"columns":[],"layout":{}}}'
};

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

```go
package main

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

func main() {

	url := "https://ssuccessv2.com/app/api/v1/save-template"

	payload := strings.NewReader("{\n  \"name\": \"Mailing Labels\",\n  \"template_type_id\": 1,\n  \"academic_year_id\": 2025,\n  \"payload\": {\n    \"filters\": {},\n    \"columns\": [],\n    \"layout\": {}\n  }\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
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/save-template")

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  \"name\": \"Mailing Labels\",\n  \"template_type_id\": 1,\n  \"academic_year_id\": 2025,\n  \"payload\": {\n    \"filters\": {},\n    \"columns\": [],\n    \"layout\": {}\n  }\n}"

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

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

HttpResponse<String> response = Unirest.post("https://ssuccessv2.com/app/api/v1/save-template")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Mailing Labels\",\n  \"template_type_id\": 1,\n  \"academic_year_id\": 2025,\n  \"payload\": {\n    \"filters\": {},\n    \"columns\": [],\n    \"layout\": {}\n  }\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/save-template', [
  'body' => '{
  "name": "Mailing Labels",
  "template_type_id": 1,
  "academic_year_id": 2025,
  "payload": {
    "filters": {},
    "columns": [],
    "layout": {}
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/save-template");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"name\": \"Mailing Labels\",\n  \"template_type_id\": 1,\n  \"academic_year_id\": 2025,\n  \"payload\": {\n    \"filters\": {},\n    \"columns\": [],\n    \"layout\": {}\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "name": "Mailing Labels",
  "template_type_id": 1,
  "academic_year_id": 2025,
  "payload": [
    "filters": [],
    "columns": [],
    "layout": []
  ]
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "https://ssuccessv2.com/app/api/v1/save-template")! 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()
```