Notifications

Send notification to all recipients in a group

post/api/v1/notifications/send-to-group

Request

  • Base URL: https://wardenpoint.com (the document declares no server; this is the origin it was published from)
  • URL: https://wardenpoint.com/api/v1/notifications/send-to-group
  • Auth: API key in header X-API-Key

Request body

group_uuidstring uuid required

Which group to page. Everyone in it is a separate delivery with its own outcome — one member being unreachable does not stop the others. The group's own notification settings decide the channel and the ladder; a member's personal settings apply only where the group rule defers to them.

messagestring required

The alert text, as each member will read it. On a voice channel it is also what gets spoken. Keep it self-contained — a human woken at 4am sees this and nothing else.

priority'low' | 'normal' | 'high' | 'critical'

Which of the group's notification settings applies — that is what picks the channel and the escalation ladder. Defaults to normal when omitted.

Response

Group notification results. Successful responses carry a delivery object describing where this company stands against its plan quota — see DeliveryOverageState. Exceeding that quota never blocks a send; only the non-tariff daily ceiling does, and that answers 429 with code: DELIVERY_CEILING_REACHED.

Changes

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