Documentation

SendPushNotification

Sends an iOS/Android Push Notification to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.

Request Details

SendPushNotificationRequest
Request Properties
AdvancedPlatformDelivery List<AdvancedPushPlatformMsg>

Allows you to provide precisely formatted json to target devices. This is an advanced feature, allowing you to deliver to custom plugin logic, fields, or functionality not natively supported by PlayFab.

Message String

Text of message to send.

Package PushNotificationPackage

Defines all possible push attributes like message, title, icon, etc. Some parameters are device specific - please see the PushNotificationPackage documentation for details.

Recipient (required) String

PlayFabId of the recipient of the push notification.

Subject String

Subject of message to send (may not be displayed in all platforms)

TargetPlatforms List<PushNotificationPlatform>

Target Platforms that should receive the Message or Package. If omitted, we will send to all available platforms.

POST https://{{TitleID}}.playfabapi.com/Server/SendPushNotification
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "Recipient": "F8763A987E",
  "Message": "You have been attacked! Go defend your base!"
}
        

Response Details

SendPushNotificationResult
Result Properties

Sample Response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8


Authentication

SecretKey

Possible Error Codes

Name Code
PushNotEnabledForAccount 1094
PushServiceError 1095