Account Management - Send Push Notification From Template

Service:

Server

API Version:

241122

Sends an iOS/Android Push Notification template to a specific user, if that user's device has been configured for Push Notifications in PlayFab. If a user has linked both Android and iOS devices, both will be notified.

POST https://titleId.playfabapi.com/Server/SendPushNotificationFromTemplate

Request Header

Name	Required	Type	Description
X-SecretKey	True	string	This API requires a title secret key, available to title admins, from PlayFab Game Manager.

Request Body

Name	Required	Type	Description
PushNotificationTemplateId	True	string	Id of the push notification template.
Recipient	True	string	PlayFabId of the push notification recipient.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

Responses

Name	Type	Description
200 OK	SendPushNotificationResult
400 Bad Request	ApiErrorWrapper	This is the outer wrapper for all responses with errors

Security

X-SecretKey

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

Type: apiKey
In: header

Definitions

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
SendPushNotificationFromTemplateRequest	Represents the request for sending a push notification template to a recipient.
SendPushNotificationResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name	Type	Description
code	integer	Numerical HTTP code
error	string	Playfab error code
errorCode	integer	Numerical PlayFab error code
errorDetails	object	Detailed description of individual issues with the request object
errorMessage	string	Description for the PlayFab errorCode
status	string	String HTTP code

SendPushNotificationFromTemplateRequest

Represents the request for sending a push notification template to a recipient.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
PushNotificationTemplateId	string	Id of the push notification template.
Recipient	string	PlayFabId of the push notification recipient.

SendPushNotificationResult

Error Codes

Name	Code
PushNotEnabledForAccount	1094
PushNotificationTemplateNotFound	1417
PushServiceError	1095