Send push notification to multiple users

Sends a push notification to all active device tokens for multiple specified user IDs

post/notifications/push/send/users

Request body

userIdsstring[] required

Array of user IDs to send notification to

Example request

{
  "userIds": [
    "user123",
    "user456",
    "user789"
  ],
  "payload": {
    "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

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.