Skip to main content
POST
Setup 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

When using the Apple Push Notification service (APNS) or the development version (APNS_SANDBOX), the APNS Private Key should be used as the Credential in this call. With Google Cloud Messaging (GCM), the Android API Key should be used. The current ARN (if one exists) can be overwritten by setting the OverwriteOldARN boolean to true.

When using the Apple Push Notification service (APNS) or the development version (APNS_SANDBOX), the APNS Private Key should be used as the Credential in this call. With Google Cloud Messaging (GCM), the Android API Key should be used. The current ARN (if one exists) can be overwritten by setting the OverwriteOldARN boolean to true.

Credential
string
required

Credential is the Private Key for APNS/APNS_SANDBOX, and the API Key for GCM

OverwriteOldARN
boolean
required

replace any existing ARN with the newly generated one. If this is set to false, an error will be returned if notifications have already setup for this platform.

Platform
enum<string>
required

supported notification platforms are Apple Push Notification Service (APNS and APNS_SANDBOX) for iOS and Google Cloud Messaging (GCM) for Android

Available options:
GCM,
APNS,
APNS_SANDBOX
Key
string

for APNS, this is the PlatformPrincipal (SSL Certificate)

Name
string

This field is deprecated and any usage of this will cause the API to fail.

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
Example:
Last modified on October 1, 2026