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

# Schedule an email broadcast

POST https://ssuccessv2.com/app/api/v1/broadcast/email/create
Content-Type: multipart/form-data

Creates an email broadcast for selected school recipients, optionally with attachments, forms, document templates, and previous-year balance details. The sent date must be an ISO 8601 timestamp with an offset.

Reference: https://docs.schoolset.io/api-reference/school-set-api/broadcasts/create-email-broadcast

## Authentication

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

## Request

### Body (multipart/form-data)

This endpoint expects a multipart form.

- `academic_year_id` (integer, required)
- `broadcast_method_id` (integer, optional)
- `recipients_id` (list of ApiV1BroadcastEmailCreatePostRequestBodyContentMultipartFormDataSchemaRecipientsIdItems, required)
- `attachments_id` (list of integer, optional)
- `sent_date` (datetime, required)
- `subject` (string, required)
- `message` (string, required)
- `attributes` (string, optional) — JSON-encoded broadcast attributes
- `include_previous_years_balance` (boolean, optional)
- `previous_years_balance_type` (enum, optional)
- `form_id` (integer, optional)
- `document_template_recipients` (list of ApiV1BroadcastEmailCreatePostRequestBodyContentMultipartFormDataSchemaDocumentTemplateRecipientsItems, optional)
- `form_recipients` (list of ApiV1BroadcastEmailCreatePostRequestBodyContentMultipartFormDataSchemaFormRecipientsItems, optional)

## Response

### 200

Email broadcast created

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

## Errors

### 401 Unauthorized Error

Authentication is required

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

### 403 Forbidden Error

Broadcast creation is not permitted

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

### 422 Unprocessable Entity Error

Request fields or recipient entries are invalid

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

## Types

### ApiV1BroadcastEmailCreatePostResponsesContentApplicationJsonSchemaData

- `id` (integer, optional)
- `subject` (string, optional)
- `message` (string, optional)
- `sent_date` (datetime, optional)
- `status` (ApiV1BroadcastEmailCreatePostResponsesContentApplicationJsonSchemaDataStatus, optional)
- `to` (list of ApiV1BroadcastEmailCreatePostResponsesContentApplicationJsonSchemaDataToItems, optional)
- `attachments` (list of ApiV1BroadcastEmailCreatePostResponsesContentApplicationJsonSchemaDataAttachmentsItems, optional)

### ApiV1BroadcastEmailCreatePostResponsesContentApplicationJsonSchemaDataStatus

### ApiV1BroadcastEmailCreatePostResponsesContentApplicationJsonSchemaDataToItems

### ApiV1BroadcastEmailCreatePostResponsesContentApplicationJsonSchemaDataAttachmentsItems

## Examples

**Request**

```json
{
  "academic_year_id": 2026,
  "broadcast_method_id": 1,
  "recipients_id": [
    {
      "type": "family",
      "id": 204,
      "grade_ids": [
        7
      ]
    }
  ],
  "sent_date": {},
  "subject": "September attendance reminder",
  "message": "Please review your student's attendance in SchoolSet."
}
```

**Response**

```json
{
  "status": "success",
  "message": "",
  "data": {
    "id": 731,
    "subject": "September attendance reminder",
    "message": "Please review your student's attendance in SchoolSet.",
    "sent_date": "2024-01-15T09:30:00Z",
    "status": {
      "id": 3,
      "title": "Scheduled",
      "sys_name": "scheduled"
    },
    "to": [
      {
        "id": 204,
        "type": "family"
      }
    ],
    "attachments": []
  }
}
```

**SDK Code**

```python Broadcasts_createEmailBroadcast_example
import requests

url = "https://ssuccessv2.com/app/api/v1/broadcast/email/create"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"academic_year_id\"\r\n\r\n2026\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"broadcast_method_id\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients_id\"\r\n\r\n[\n  {\n    \"type\": \"family\",\n    \"id\": 204,\n    \"grade_ids\": [\n      7\n    ]\n  }\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sent_date\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\nSeptember attendance reminder\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nPlease review your student's attendance in SchoolSet.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_previous_years_balance\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"previous_years_balance_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_template_recipients\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_recipients\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "multipart/form-data; boundary=---011000010111000001101001"
}

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

print(response.json())
```

```javascript Broadcasts_createEmailBroadcast_example
const url = 'https://ssuccessv2.com/app/api/v1/broadcast/email/create';
const form = new FormData();
form.append('academic_year_id', '2026');
form.append('broadcast_method_id', '1');
form.append('recipients_id', '[
  {
    "type": "family",
    "id": 204,
    "grade_ids": [
      7
    ]
  }
]');
form.append('attachments_id', '');
form.append('sent_date', '{}');
form.append('subject', 'September attendance reminder');
form.append('message', 'Please review your student's attendance in SchoolSet.');
form.append('attributes', '');
form.append('include_previous_years_balance', '');
form.append('previous_years_balance_type', '');
form.append('form_id', '');
form.append('document_template_recipients', '');
form.append('form_recipients', '');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

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

```go Broadcasts_createEmailBroadcast_example
package main

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

func main() {

	url := "https://ssuccessv2.com/app/api/v1/broadcast/email/create"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"academic_year_id\"\r\n\r\n2026\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"broadcast_method_id\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients_id\"\r\n\r\n[\n  {\n    \"type\": \"family\",\n    \"id\": 204,\n    \"grade_ids\": [\n      7\n    ]\n  }\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sent_date\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\nSeptember attendance reminder\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nPlease review your student's attendance in SchoolSet.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_previous_years_balance\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"previous_years_balance_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_template_recipients\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_recipients\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")

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

	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 Broadcasts_createEmailBroadcast_example
require 'uri'
require 'net/http'

url = URI("https://ssuccessv2.com/app/api/v1/broadcast/email/create")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"academic_year_id\"\r\n\r\n2026\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"broadcast_method_id\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients_id\"\r\n\r\n[\n  {\n    \"type\": \"family\",\n    \"id\": 204,\n    \"grade_ids\": [\n      7\n    ]\n  }\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sent_date\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\nSeptember attendance reminder\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nPlease review your student's attendance in SchoolSet.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_previous_years_balance\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"previous_years_balance_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_template_recipients\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_recipients\"\r\n\r\n\r\n-----011000010111000001101001--\r\n"

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

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

HttpResponse<String> response = Unirest.post("https://ssuccessv2.com/app/api/v1/broadcast/email/create")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"academic_year_id\"\r\n\r\n2026\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"broadcast_method_id\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients_id\"\r\n\r\n[\n  {\n    \"type\": \"family\",\n    \"id\": 204,\n    \"grade_ids\": [\n      7\n    ]\n  }\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sent_date\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\nSeptember attendance reminder\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nPlease review your student's attendance in SchoolSet.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_previous_years_balance\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"previous_years_balance_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_template_recipients\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_recipients\"\r\n\r\n\r\n-----011000010111000001101001--\r\n")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://ssuccessv2.com/app/api/v1/broadcast/email/create', [
  'multipart' => [
    [
        'name' => 'academic_year_id',
        'contents' => '2026'
    ],
    [
        'name' => 'broadcast_method_id',
        'contents' => '1'
    ],
    [
        'name' => 'recipients_id',
        'contents' => '[
  {
    "type": "family",
    "id": 204,
    "grade_ids": [
      7
    ]
  }
]'
    ],
    [
        'name' => 'sent_date',
        'contents' => '{}'
    ],
    [
        'name' => 'subject',
        'contents' => 'September attendance reminder'
    ],
    [
        'name' => 'message',
        'contents' => 'Please review your student\'s attendance in SchoolSet.'
    ]
  ]
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp Broadcasts_createEmailBroadcast_example
using RestSharp;

var client = new RestClient("https://ssuccessv2.com/app/api/v1/broadcast/email/create");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"academic_year_id\"\r\n\r\n2026\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"broadcast_method_id\"\r\n\r\n1\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"recipients_id\"\r\n\r\n[\n  {\n    \"type\": \"family\",\n    \"id\": 204,\n    \"grade_ids\": [\n      7\n    ]\n  }\n]\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachments_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"sent_date\"\r\n\r\n{}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"subject\"\r\n\r\nSeptember attendance reminder\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"message\"\r\n\r\nPlease review your student's attendance in SchoolSet.\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attributes\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"include_previous_years_balance\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"previous_years_balance_type\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_id\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"document_template_recipients\"\r\n\r\n\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"form_recipients\"\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Broadcasts_createEmailBroadcast_example
import Foundation

let headers = ["Authorization": "Bearer <token>"]
let parameters = [
  [
    "name": "academic_year_id",
    "value": "2026"
  ],
  [
    "name": "broadcast_method_id",
    "value": "1"
  ],
  [
    "name": "recipients_id",
    "value": "[
  {
    \"type\": \"family\",
    \"id\": 204,
    \"grade_ids\": [
      7
    ]
  }
]"
  ],
  [
    "name": "attachments_id",
    "value": 
  ],
  [
    "name": "sent_date",
    "value": "{}"
  ],
  [
    "name": "subject",
    "value": "September attendance reminder"
  ],
  [
    "name": "message",
    "value": "Please review your student's attendance in SchoolSet."
  ],
  [
    "name": "attributes",
    "value": 
  ],
  [
    "name": "include_previous_years_balance",
    "value": 
  ],
  [
    "name": "previous_years_balance_type",
    "value": 
  ],
  [
    "name": "form_id",
    "value": 
  ],
  [
    "name": "document_template_recipients",
    "value": 
  ],
  [
    "name": "form_recipients",
    "value": 
  ]
]

let boundary = "---011000010111000001101001"

var body = ""
var error: NSError? = nil
for param in parameters {
  let paramName = param["name"]!
  body += "--\(boundary)\r\n"
  body += "Content-Disposition:form-data; name=\"\(paramName)\""
  if let filename = param["fileName"] {
    let contentType = param["content-type"]!
    let fileContent = String(contentsOfFile: filename, encoding: String.Encoding.utf8)
    if (error != nil) {
      print(error as Any)
    }
    body += "; filename=\"\(filename)\"\r\n"
    body += "Content-Type: \(contentType)\r\n\r\n"
    body += fileContent
  } else if let paramValue = param["value"] {
    body += "\r\n\r\n\(paramValue)"
  }
}

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