Sign in
push-notifications

Send push notification to all users

Broadcasts a push notification to all active device tokens in the system. Use with caution for large user bases.

post/notifications/push/send/all

Request body

titlestring required

Notification title

bodystring required

Notification body

dataobject

Additional data payload

imageUrlstring

Image URL for notification

clickActionstring

Click action for Android

Example request

{
  "title": "New Message",
  "body": "You have a new message from John",
  "data": {
    "messageId": "123",
    "senderId": "user456"
  },
  "imageUrl": "https://example.com/image.jpg",
  "clickAction": "OPEN_MESSAGE"
}

Response

Broadcast notification sent successfully

successCountnumber required

Number of successful notifications sent

failureCountnumber required

Number of failed notifications

resultsstring[] required

Detailed results for each notification attempt

Example response

{
  "successCount": 5,
  "failureCount": 1,
  "results": [
    {
      "success": true
    },
    {
      "success": false,
      "error": "Invalid token"
    }
  ]
}

Changes

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