Schedule a voice broadcast

POST

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

POST

/app/api/v1/broadcast/voice/create

$ curl -X POST https://ssuccessv2.com/app/api/v1/broadcast/voice/create \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: multipart/form-data" \
>      -F academic_year_id='2025' \
>      -F recipients_id="[{\"type\":\"family\",\"id\":88,\"grade_ids\":[]}]" \
>      -F sent_date='{}' \
>      -F subject="Welcome back to school" \
>      -F voice_file_id='9271'

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 1851,
6     "academic_year": {
7       "id": 2025,
8       "title": "2026–2027"
9     },
10     "type": {
11       "id": 3,
12       "title": "Voice",
13       "sys_name": "voice"
14     },
15     "method": {
16       "id": 2,
17       "sys_name": "voice"
18     },
19     "status": {
20       "id": 3,
21       "title": "Scheduled",
22       "sys_name": "scheduled"
23     },
24     "subject": "Welcome back to school",
25     "sent_date": {},
26     "voice": {
27       "id": 9271,
28       "file_name": "welcome-back.mp3"
29     }
30   }
31 }

Creates a scheduled voice broadcast using an uploaded voice recording and sends it to the selected recipients.

Authentication

AuthorizationBearer

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

Request

This endpoint expects a multipart form.

academic_year_idintegerRequired

broadcast_method_idinteger or nullOptional

recipients_idstringRequired

JSON array of recipient objects

sent_datedatetimeRequired

subjectstringRequired

voice_file_idintegerRequired

Uploaded voice FileManager ID

attributesstring or nullOptional

JSON-encoded attributes

Response

Voice broadcast created and queued.

statusstring

messagestring

dataobject

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error