MODULE GUIDE · 11 OCT 2026

Notices, announcements & messages

Coordinate school notices, events, complaints, audience-based announcements and direct conversations.

Try guided demo →Download guide ↓

OVERVIEW

What you can do

Notices and events

Announcement templates

Audience preview

Delivery report

Scoped messages

Complaints

BEFORE YOU BEGIN

Access & setup

Intended access: Assigned account with the required permissions.

An assigned school account with the required permissions.
The academic, student or staff setup used by this workflow.

Required permission keys

communication:viewcommunication:createcommunication:updatecommunication:deletecommunication:manage

Use the public sample demo to learn this flow. Your assigned ERP account determines access to actual school records.

STEP BY STEP

How the workflow works

01
Choose the notice, announcement or conversation workflow
An assigned school account with the required permissions.
02
Select the permitted audience and prepare the content
Announcement templates is part of the documented workflow.
03
Preview reachability before sending where available
Audience preview is part of the documented workflow.
04
Review delivery reports, replies or complaint status
Review the result in the connected record or workspace before moving on.

Request fields to understand

Source-declared fields used by related operations; each operation has its own validation and scope.

Field	Declared type	Input
`name`	string	Optional
`category`	string	Optional
`subject`	string	Optional
`body`	string	Required by declaration
`channels`	string[]	Optional
`isActive`	boolean	Optional
`audience`	string	Optional
`targeting`	AudienceTargetingDto	Optional
`title`	string	Required by declaration
`message`	string	Optional
`templateId`	string	Optional
`scheduledAt`	string	Optional
`isPinned`	boolean	Optional
`classId`	string	Optional
`sectionId`	string	Optional
`expiresAt`	string	Optional
`description`	string	Optional
`startAt`	string	Required by declaration
`endAt`	string	Optional
`venue`	string	Optional
`rsvpEnabled`	boolean	Optional
`isAllDay`	boolean	Optional
`priority`	string	Optional
`studentId`	string	Optional

CURRENT BEHAVIOUR

Rules & current limits

External SMS, email and WhatsApp delivery requires configured providers. A saved record is not evidence that every recipient received it.

Source inventory checked on 11 October 2026. Guide availability confirms documentation publication, not certification of every external service or device flow.

LEARN BY DOING

Try notices, announcements & messages

Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.

Launch guided demo →

FOR IMPLEMENTERS

API & permissions reference

This is the module’s source-declared endpoint catalogue. Reading this reference does not execute any request.

28 source-declared operations

GET/api/v1/announcements/templates

List Templates

communication:view

POST/api/v1/announcements/templates

Create Template

communication:create

Declared request fields: name (required), category (optional), subject (optional), body (required), channels (optional).

PATCH/api/v1/announcements/templates/:id

Update Template

communication:update

Declared request fields: name (optional), category (optional), subject (optional), body (optional), channels (optional), isActive (optional).

DELETE/api/v1/announcements/templates/:id

Remove Template

communication:delete

POST/api/v1/announcements/preview-audience

Count and channel-reachability for an audience

communication:view

Declared request fields: audience (required), targeting (optional).

GET/api/v1/announcements

List

communication:view

GET/api/v1/announcements/:id

Get

communication:view

GET/api/v1/announcements/:id/deliveries

Per-recipient delivery report

communication:view

POST/api/v1/announcements

Create

communication:create

Declared request fields: title (optional), message (optional), audience (required), targeting (optional), channels (optional), templateId (optional), scheduledAt (optional).

POST/api/v1/announcements/:id/send

Deliver the announcement across its channels

communication:manage

GET/api/v1/communication/notices

Notices

communication:view

POST/api/v1/communication/notices

Create Notice

communication:create

Declared request fields: title (required), body (optional), audience (optional), isPinned (optional), classId (optional), sectionId (optional), expiresAt (optional).

PATCH/api/v1/communication/notices/:id

Update Notice

communication:update

DELETE/api/v1/communication/notices/:id

Remove Notice

communication:delete

GET/api/v1/communication/events

Events

communication:view

POST/api/v1/communication/events

Create Event

communication:create

Declared request fields: title (required), description (optional), startAt (required), endAt (optional), venue (optional), audience (optional), rsvpEnabled (optional), category (optional), isAllDay (optional), classId (optional), sectionId (optional).

DELETE/api/v1/communication/events/:id

Remove Event

communication:delete

GET/api/v1/communication/complaints

Complaints

communication:view

POST/api/v1/communication/complaints

Create Complaint

communication:create

Declared request fields: subject (required), description (optional), category (optional), priority (optional), studentId (optional).

PATCH/api/v1/communication/complaints/:id

Update Complaint

communication:update

Declared request fields: status (optional), resolution (optional).

GET/api/v1/messages/contacts

Addressable contacts for the signed-in user