Notifications
Send transactional WhatsApp, email, or bulk notifications
Notification endpoints fan out messages to one recipient (WhatsApp/email) or
many (bulk). All endpoints require an authenticated principal that is not
a guest.
Resource overview
POST
/api/notifications/whatsappAPI key · SessionPermissions: notifications.sendPOST
/api/notifications/emailAPI key · SessionPermissions: notifications.sendPOST
/api/notifications/bulkAPI key · SessionPermissions: notifications.sendSend WhatsApp
POST
/api/notifications/whatsappAPI key · SessionPermissions: notifications.send| Name | Type | Required | Description |
|---|---|---|---|
to | string | Required | E.164 phone number, e.g. `+14155551234`. |
message | string | Required | Message body. Capped at the provider's per-message limit. |
200
{ "success": true }Send email
POST
/api/notifications/emailAPI key · SessionPermissions: notifications.send| Name | Type | Required | Description |
|---|---|---|---|
to | string | Required | Recipient email. |
subject | string | Required | Subject line. |
html | string | Required | HTML body. |
text | string | Optional | Plain-text fallback. Auto-derived from `html` when omitted. |
200
{ "success": true, "messageId": "msg-uuid" }Bulk send
POST
/api/notifications/bulkAPI key · SessionPermissions: notifications.send| Name | Type | Required | Description |
|---|---|---|---|
type | string | Required | `email`, `whatsapp`, or `both`. |
recipients | string | Optional | `team`, `guests`, or `all`. Default: guests |
eventId | string | Optional | Required when `recipients=guests` — scopes to that event's confirmed guests. |
subject | string | Optional | Required for `email` / `both`. |
html | string | Optional | Required for `email` / `both`. |
message | string | Optional | Required for `whatsapp` / `both`. |
Recipient resolution
team— every user with roleadmin,coordinator, orteam_leadin your org.guests(+eventId) — every confirmed guest on that event.all— currently a no-op; future-reserved.
200
{
"success": true,
"recipientCount": 42,
"results": {
"email": { "guest@example.com": { "success": true } },
"whatsapp": { "+14155551234": { "success": true } }
}
}