Schedule an email broadcast

POST

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

POST

/app/api/v1/broadcast/email/create

$ curl -X POST https://ssuccessv2.com/app/api/v1/broadcast/email/create \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: multipart/form-data" \
>      -F academic_year_id='2026' \
>      -F broadcast_method_id='1' \
>      -F recipients_id='[
>   {
>     "type": "family",
>     "id": 204,
>     "grade_ids": [
>       7
>     ]
>   }
> ]' \
>      -F sent_date='{}' \
>      -F subject="September attendance reminder" \
>      -F message="Please review your student's attendance in SchoolSet."

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 731,
6     "subject": "September attendance reminder",
7     "message": "Please review your student's attendance in SchoolSet.",
8     "sent_date": "2024-01-15T09:30:00Z",
9     "status": {
10       "id": 3,
11       "title": "Scheduled",
12       "sys_name": "scheduled"
13     },
14     "to": [
15       {
16         "id": 204,
17         "type": "family"
18       }
19     ],
20     "attachments": []
21   }
22 }

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.

Authentication

AuthorizationBearer

The signed-in SchoolSet user token sent by the frontend.

Request

This endpoint expects a multipart form.

academic_year_idintegerRequired

broadcast_method_idintegerOptional

recipients_idlist of objectsRequired

attachments_idlist of integersOptional

sent_datedatetimeRequired

subjectstringRequired

messagestringRequired

attributesstringOptional

JSON-encoded broadcast attributes

include_previous_years_balancebooleanOptional

previous_years_balance_typeenumOptional

Allowed values:

form_idintegerOptional

document_template_recipientslist of objectsOptional

form_recipientslist of objectsOptional

Response

Email broadcast created

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

422

Unprocessable Entity Error