GET
/api/v1/messages/contactsAddressable contacts for the signed-in user
Authenticated scope and endpoint-specific rulesSCREEN GUIDE · 11 OCT 2026
Notices, announcements & messages
Use notices, announcements & messages in the school workspace. Coordinate school notices, events, complaints, audience-based announcements and direct conversations.
OVERVIEW
What you can do
01
New
02
withdraw
03
Addressable contacts for the signed-in user
04
My conversations, most recent first
05
Get Thread
06
Start a conversation (or add to the existing one)
07
Send
08
Mark Read
BEFORE YOU BEGIN
Access & setup
Intended access: Assigned account with the required permissions.
- A school account with the permissions shown below.
- Choose the relevant school, academic session or child before working.
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
A school account with the permissions shown below.
- 02
Select the permitted audience and prepare the content
withdraw is part of the documented workflow.
- 03
Preview reachability before sending where available
Addressable contacts for the signed-in user 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 |
|---|---|---|
toUserId | string | Required by declaration |
body | string | Required by declaration |
subject | string | Optional |
studentId | string | Optional |
muted | boolean | Required by declaration |
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
Launch guided demo →Try notices, announcements & messages
Open a guided sample workspace, try the available actions, then reset whenever you like. No login required.
FOR IMPLEMENTERS
API & permissions reference
These are the source-matched API operations connected to this guide. Reading this reference does not execute any request.
8 source-declared operations
GET
/api/v1/messagesMy conversations, most recent first
Authenticated scope and endpoint-specific rulesGET
/api/v1/messages/:idGet Thread
Authenticated scope and endpoint-specific rulesPOST
/api/v1/messagesStart a conversation (or add to the existing one)
Authenticated scope and endpoint-specific rulesDeclared request fields: toUserId (required), body (required), subject (optional), studentId (optional).
POST
/api/v1/messages/:id/messagesSend
Authenticated scope and endpoint-specific rulesDeclared request fields: body (required).
POST
/api/v1/messages/:id/readMark Read
Authenticated scope and endpoint-specific rulesPOST
/api/v1/messages/:id/muteMute
Authenticated scope and endpoint-specific rulesDeclared request fields: muted (required).
DELETE
/api/v1/messages/messages/:messageIdWithdraw your own message
Authenticated scope and endpoint-specific rulesOpen the actual application
ERP links use your assigned account. Record-specific pages start from the list so you can choose a real record.