Documentation

RegisterForIOSPushNotification

Registers the iOS device to receive push notifications

Request Details

The steps to configure and send Push Notifications is described in the PlayFab tutorials, here: https://api.playfab.com/docs/pushCrashCourse/

RegisterForIOSPushNotificationRequest
Request Properties
ConfirmationMessage String

Message to display when confirming push notification.

DeviceToken (required) String

Unique token generated by the Apple Push Notification service when the title registered to receive push notifications.

SendPushNotificationConfirmation Boolean

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

POST https://{{TitleID}}.playfabapi.com/Client/RegisterForIOSPushNotification
    Content-Type: application/json
    X-Authentication: <user_session_ticket_value>
{
  "DeviceToken": "39872f98eb882brn8hg3889",
  "SendPushNotificationConfirmation": true,
  "ConfirmationMessage": "Welcome to PlayFab"
}
        

Response Details

RegisterForIOSPushNotificationResult
Result Properties

Sample Response

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


Authentication

SessionTicket

Possible Error Codes

Name Code
NoPushNotificationARNForTitle 1083