Skip to main content
POST
Send Push Notification

Authorizations

X-SecretKey
string
header
required

This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Body

application/json
Recipient
string
required

PlayFabId of the recipient of the push notification.

AdvancedPlatformDelivery
object[]

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.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Message
string

Text of message to send.

Package
object

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

Subject
string

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

TargetPlatforms
enum<string>[]

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

Available options:
ApplePushNotificationService,
GoogleCloudMessaging

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026