Push Notifications

Send real-time push notifications to Untis Platform users — either as standard announcements or high-priority emergency alerts.

v1 Send-only Endpoints: 2

Note

This API only sends push notifications. Client-side delivery and push token management are handled automatically by the platform infrastructure.

---

Use cases

Emergency Alerts

Trigger high-priority emergency notifications for immediate school evacuation or urgent security protocols.

Administrative Broadcasts

Send automated announcements, event reminders, and general updates to specific groups or users.

---

Endpoints

Method	Operation ID	Description
POST	notification	Send a standard push notification to one or more recipients
POST	emergency-notification	Send a high-priority emergency push notification to one or more recipients

---

Required Permissions

To successfully submit notifications, the caller must possess the appropriate permission based on the notification type:

Notification Type	Required Permission	Endpoint
Standard	NOTIFICATION_API_WRITE	POST /notifications
Emergency	NOTIFICATION_API_EMERGENCY_WRITE	POST /emergency-notifications

Caution

Calling these endpoints without the required permission or experimental flag will result in a 403 Forbidden response.

---

Processing & Partial Success (PARTIALLY_ACCEPTED)

To ensure that critical alerts (especially emergencies) are not blocked by a single invalid recipient, the notification endpoints support partial delivery:

• ACCEPTED (200 OK): All specified recipient UUIDs were valid and active. (Note: Acceptance by the API means the request was successfully processed and queued/dispatched, but guaranteed delivery to the end client’s device is not implied at this stage).
• PARTIALLY_ACCEPTED (200 OK): Some recipients failed validation (e.g., inactive user, not found, or invalid UUID format), but at least one valid recipient was successfully processed and the notification was dispatched.
• NO_ACTIVE_RECIPIENT_USER_FOUND (422 Unprocessable Entity): The request was rejected entirely because zero valid or active recipients were found.

If any recipient-level issues occur, the response will contain a recipientFailures array detailing the exact reason for each failure:

Reason	Description
NOT_FOUND	No user found with the given external UUID in the tenant.
NOT_ACTIVE	The user exists but is currently inactive.
INVALID_UUID	The provided string does not match a valid UUID format.

---

Batching & Correlation

When sending notifications to a large number of users that exceed a single request limit, you can split the recipients into batches and link them together using the correlationId field in the request body.

---

Related pages

Authentication Model Understand token requirements and permissions needed to call notification endpoints.

User Management Query user IDs and statuses before sending targeted broadcasts.

---

API reference