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

# Create a workflow template

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

Creates a workflow template with ordered stages and optional required checks for an active-school module.

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

- `module` (string, required)
- `name` (string, required)
- `stages` (list of ApiV1WorkflowTemplatePostRequestBodyContentApplicationJsonSchemaStagesItems, required)
- `form_identifier_key` (string, optional, nullable)
- `module_ids` (list of integer, optional)

## Response

### 200

Workflow template was saved and its refreshed board returned.

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

## Errors

### 401 Unauthorized Error

Authentication is required to create workflow templates.

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

### 403 Forbidden Error

The user cannot create workflow templates in the active school.

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

### 422 Unprocessable Entity Error

Template fields or workflow stage checks failed validation.

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

## Types

### ApiV1WorkflowTemplatePostRequestBodyContentApplicationJsonSchemaStagesItems

- `name` (string, required)
- `id` (integer, optional, nullable)
- `color` (string, optional, nullable)
- `required_checks` (list of ApiV1WorkflowTemplatePostRequestBodyContentApplicationJsonSchemaStagesItemsRequiredChecksItems, optional)

### ApiV1WorkflowTemplatePostResponsesContentApplicationJsonSchemaData

- `template` (ApiV1WorkflowTemplatePostResponsesContentApplicationJsonSchemaDataTemplate, optional)
- `instances` (list of ApiV1WorkflowTemplatePostResponsesContentApplicationJsonSchemaDataInstancesItems, optional)

### ApiV1WorkflowTemplatePostRequestBodyContentApplicationJsonSchemaStagesItemsRequiredChecksItems

### ApiV1WorkflowTemplatePostResponsesContentApplicationJsonSchemaDataTemplate

### ApiV1WorkflowTemplatePostResponsesContentApplicationJsonSchemaDataInstancesItems

## Examples

**Request**

```json
{
  "module": "form_submission",
  "name": "Admissions",
  "stages": [
    {
      "name": "New",
      "color": "#3B82F6"
    },
    {
      "name": "Reviewed",
      "color": "#10B981"
    }
  ],
  "form_identifier_key": "admission",
  "module_ids": [
    101,
    102
  ]
}
```

**Response**

```json
{
  "status": "success",
  "message": "Saved successfully.",
  "data": {
    "template": {},
    "instances": [
      {}
    ]
  }
}
```

**SDK Code**

```python
import requests

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

payload = {
    "module": "form_submission",
    "name": "Admissions",
    "stages": [
        {
            "name": "New",
            "color": "#3B82F6"
        },
        {
            "name": "Reviewed",
            "color": "#10B981"
        }
    ],
    "form_identifier_key": "admission",
    "module_ids": [101, 102]
}
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/workflow/template';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"module":"form_submission","name":"Admissions","stages":[{"name":"New","color":"#3B82F6"},{"name":"Reviewed","color":"#10B981"}],"form_identifier_key":"admission","module_ids":[101,102]}'
};

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/workflow/template"

	payload := strings.NewReader("{\n  \"module\": \"form_submission\",\n  \"name\": \"Admissions\",\n  \"stages\": [\n    {\n      \"name\": \"New\",\n      \"color\": \"#3B82F6\"\n    },\n    {\n      \"name\": \"Reviewed\",\n      \"color\": \"#10B981\"\n    }\n  ],\n  \"form_identifier_key\": \"admission\",\n  \"module_ids\": [\n    101,\n    102\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/workflow/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  \"module\": \"form_submission\",\n  \"name\": \"Admissions\",\n  \"stages\": [\n    {\n      \"name\": \"New\",\n      \"color\": \"#3B82F6\"\n    },\n    {\n      \"name\": \"Reviewed\",\n      \"color\": \"#10B981\"\n    }\n  ],\n  \"form_identifier_key\": \"admission\",\n  \"module_ids\": [\n    101,\n    102\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/workflow/template")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"module\": \"form_submission\",\n  \"name\": \"Admissions\",\n  \"stages\": [\n    {\n      \"name\": \"New\",\n      \"color\": \"#3B82F6\"\n    },\n    {\n      \"name\": \"Reviewed\",\n      \"color\": \"#10B981\"\n    }\n  ],\n  \"form_identifier_key\": \"admission\",\n  \"module_ids\": [\n    101,\n    102\n  ]\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/workflow/template', [
  'body' => '{
  "module": "form_submission",
  "name": "Admissions",
  "stages": [
    {
      "name": "New",
      "color": "#3B82F6"
    },
    {
      "name": "Reviewed",
      "color": "#10B981"
    }
  ],
  "form_identifier_key": "admission",
  "module_ids": [
    101,
    102
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/workflow/template");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"module\": \"form_submission\",\n  \"name\": \"Admissions\",\n  \"stages\": [\n    {\n      \"name\": \"New\",\n      \"color\": \"#3B82F6\"\n    },\n    {\n      \"name\": \"Reviewed\",\n      \"color\": \"#10B981\"\n    }\n  ],\n  \"form_identifier_key\": \"admission\",\n  \"module_ids\": [\n    101,\n    102\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "module": "form_submission",
  "name": "Admissions",
  "stages": [
    [
      "name": "New",
      "color": "#3B82F6"
    ],
    [
      "name": "Reviewed",
      "color": "#10B981"
    ]
  ],
  "form_identifier_key": "admission",
  "module_ids": [101, 102]
] as [String : Any]

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

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