Update a scheduled voice broadcast

Updates a scheduled voice broadcast. A new uploaded recording may be supplied; the existing recording is retained when voice_file_id is omitted.

Authentication

AuthorizationBearer

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

Path parameters

idlongRequired
Broadcast identifier.

Request

This endpoint expects an object.
academic_year_idinteger or nullOptional
recipients_idlist of objectsOptional
sent_datedatetime or nullOptional
subjectstring or nullOptional
voice_file_idinteger or nullOptional
attributesstring or nullOptional

JSON-encoded attributes

Response

Voice broadcast updated.
statusstringOptional
messagestringOptional
dataobjectOptional

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error