[BETA] Send a push announcement to app users

Sends an announcement (title + body) as a push and/or in-app notification, and records it in the "Messages" tab of the school's app. The endpoint validates and resolves external references, then dispatches asynchronously — a 200 confirms dispatch, not delivery.

Availability: this endpoint is only available to schools with a white-label app; it has no effect for schools without one.

Audience note: recipients.type "targeted_users" targets any user stored in the school's users table by their id or external reference — not only students. Some schools register non-student roles there so those users can access the white-label app, so the audience is not limited to actual students.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Notification title. The OS truncates the lock-screen preview beyond ~40-60 chars.

string
required

Notification body as plain text. Max 1500 characters for push_and_inbox, 120 for push_only (lock-screen preview).

string
required

push_and_inbox delivers a push and records it in the in-app notification centre; push_only delivers a push without an in-app record.

string

Content language. Defaults to the school language when omitted.

recipients
object
required
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json