Admin - Holiday Rollout

Notify Eligible Students

Send a mobile push (APNs/FCM) to eligible students who have the app.

Students already notified for this campaign are always excluded (holiday_rollout_notifications keeps one marker per student), so the endpoint can be re-run safely to catch newly eligible students. Use dry_run=true (default) to preview the audience without sending.

post/admin/holiday-rollout/notify-eligible

Request

  • Base URL: https://api.excellence-ai.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.excellence-ai.com/admin/holiday-rollout/notify-eligible
  • Auth: OAuth 2 (password, token URL api/login)

Request body

titlestring required
bodystring required
groupstring nullable
dry_runboolean

Response

Successful Response

dry_runboolean required
eligibleinteger required

Eligible students in the chosen group(s)

already_notifiedinteger required

Eligible students already notified for this campaign

with_deviceinteger required

Remaining recipients that have at least one device token

sentinteger
failedinteger

Changes

No operation changes recorded.