Update a scheduled SMS broadcast

PATCH

https://ssuccessv2.com/app/api/v1/broadcast/sms/update/:id

Updates the recipients or content of a scheduled SMS broadcast. The broadcast must still have Scheduled status (id 3).

AuthorizationBearer

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

idlongRequired

Broadcast identifier.

This endpoint expects an object.

academic_year_idinteger or nullOptional

form_idinteger or nullOptional

recipients_idlist of objectsOptional

sent_datedatetime or nullOptional

subjectstring or nullOptional

messagestring or nullOptional

attributesstring or nullOptional

JSON-encoded broadcast attributes

Broadcast updated.

statusstring

messagestring

dataobject

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

$	curl -X PATCH https://ssuccessv2.com/app/api/v1/broadcast/sms/update/1842 \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"status": "success",
3	"message": "",
4	"data": {
5	"id": 1842,
6	"subject": "Early dismissal on Friday",
7	"status": {
8	"id": 3,
9	"title": "Scheduled",
10	"sys_name": "scheduled"
11	},
12	"sent_date": "2024-01-15T09:30:00Z"
13	}
14	}