Cancel a scheduled broadcast

GET

https://ssuccessv2.com/app/api/v1/broadcast/cancel/:id

Cancels a scheduled broadcast, marks each recipient canceled, and returns the updated broadcast. Only broadcasts currently in Scheduled status can be canceled.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

Response

Broadcast canceled

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error

1	{
2	"status": "success",
3	"message": "Canceled successfully.",
4	"data": {
5	"id": 731,
6	"status": {
7	"id": 4,
8	"title": "Canceled",
9	"sys_name": "canceled"
10	},
11	"sent_date": "2024-01-15T09:30:00Z",
12	"subject": "September attendance reminder"
13	}
14	}