Skip to main content
POST
Android Device Push Notification Registration

Authorizations

X-Authorization
string
header
required

This API requires a client session ticket, available from any Client Login function.

Body

application/json

More information can be found on configuring your game for the Google Cloud Messaging service in the Google developer documentation, here: http://developer.android.com/google/gcm/client.html. The steps to configure and send Push Notifications is described in the PlayFab tutorials, here: https://learn.microsoft.com/gaming/playfab/features/engagement/push-notifications/quickstart.

More information can be found on configuring your game for the Google Cloud Messaging service in the Google developer documentation, here: http://developer.android.com/google/gcm/client.html. The steps to configure and send Push Notifications is described in the PlayFab tutorials, here: https://learn.microsoft.com/gaming/playfab/features/engagement/push-notifications/quickstart.

DeviceToken
string
required

Registration ID provided by the Google Cloud Messaging service when the title registered to receive push notifications (see the GCM documentation, here: http://developer.android.com/google/gcm/client.html).

ConfirmationMessage
string

Message to display when confirming push notification.

SendPushNotificationConfirmation
boolean

If true, send a test push message immediately after sucessful registration. Defaults to false.

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