Sign in
Notifications

Send the same in-app notification to up to 100 trainees, immediately or on a schedule. Requires the notifications:send scope, which is separate from messaging:send (WhatsApp). Trainees this key may not reach are returned in skipped, and trainees over the 10-per-day cap in rateLimited; both are excluded from the send, and a 429 is returned only when no recipient remains. High-risk — send an Idempotency-Key so a retry cannot double-notify.

post/api/public/notifications/bulk

Headers

Idempotency-Keystring

Optional. Send a unique key (e.g. a UUID) to make this POST safe to retry. The same key within 24h returns the original result instead of creating a duplicate.

Request body

traineeIdsstring[] required

Between 1 and 100 trainee ids

titlestring required

Short notification title

messagestring required

Body text

type'push' | 'popup' | 'both'

Delivery style. "push" (default) is a standard push notification, "popup" shows an in-app popup card, "both" sends a push and shows the popup. Never sends WhatsApp.

scheduledAtstring

Shorthand for a single future delivery: an ISO date-time. Use schedule instead for recurring sends. Cannot be combined with schedule.

Response

Created

Changes

No recorded changes to this endpoint across all 1 revision of this API.