Skip to main content
POST
Register For IOS Push Notification

Authorizations

X-Authorization
string
header
required

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

Body

application/json

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

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

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

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