Edit a scheduled email broadcast

PATCH

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

PATCH

/app/api/v1/broadcast/email/update/:id

$ curl -X PATCH https://ssuccessv2.com/app/api/v1/broadcast/email/update/731 \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "sent_date": {},
>   "subject": "Updated attendance reminder",
>   "message": "Please review the updated attendance summary."
> }'

1 {
2   "status": "success",
3   "message": "",
4   "data": {
5     "id": 731,
6     "subject": "Updated attendance reminder",
7     "message": "Please review the updated attendance summary.",
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   }
21 }

Updates the supplied fields of a scheduled email broadcast and refreshes its notifications. The broadcast must remain in Scheduled status; omitted fields are left unchanged.

Authentication

AuthorizationBearer

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

Path parameters

idintegerRequired

Request

This endpoint expects an object.

academic_year_idintegerOptional

recipients_idlist of objectsOptional

attachments_idlist of integersOptional

sent_datedatetimeOptional

subjectstringOptional

messagestringOptional

attributesstringOptional

JSON-encoded broadcast attributes

form_idintegerOptional

document_template_recipientslist of objectsOptional

form_recipientslist of objectsOptional

Response

Scheduled email broadcast updated

statusstringOptional

messagestringOptional

dataobjectOptional

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

422

Unprocessable Entity Error