Account Management - Save Push Notification Template

Service:

Server

API Version:

240401

Saves push notification template for title

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

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
Name	True	string	Name of the push notification template.
AndroidPayload		string	Android JSON for the notification template.
IOSPayload		string	IOS JSON for the notification template.
Id		string	Id of the push notification template.
LocalizedPushNotificationTemplates		LocalizedPushNotificationProperties	Dictionary of localized push notification templates with the language as the key.

Responses

Name	Type	Description
200 OK	SavePushNotificationTemplateResult	Represents the save push notification template result.
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
LocalizedPushNotificationProperties	Contains the localized push notification content.
SavePushNotificationTemplateRequest	Represents the save push notification template request.
SavePushNotificationTemplateResult	Represents the save push notification template result.

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

LocalizedPushNotificationProperties

Contains the localized push notification content.

Name	Type	Description
Message	string	Message of the localized push notification template.
Subject	string	Subject of the localized push notification template.

SavePushNotificationTemplateRequest

Represents the save push notification template request.

Name	Type	Description
AndroidPayload	string	Android JSON for the notification template.
IOSPayload	string	IOS JSON for the notification template.
Id	string	Id of the push notification template.
LocalizedPushNotificationTemplates	LocalizedPushNotificationProperties	Dictionary of localized push notification templates with the language as the key.
Name	string	Name of the push notification template.

SavePushNotificationTemplateResult

Represents the save push notification template result.

Name	Type	Description
PushNotificationTemplateId	string	Id of the push notification template that was saved.

Error Codes

Name	Code
InvalidLocalizedPushNotificationLanguage	1409
MissingLocalizedPushNotificationMessage	1410
PushNotificationTemplateAndroidPayloadMissingNotificationBody	1416
PushNotificationTemplateContainsInvalidAndroidPayload	1414
PushNotificationTemplateContainsInvalidIosPayload	1413
PushNotificationTemplateInvalidPayload	1408
PushNotificationTemplateInvalidSyntax	1419
PushNotificationTemplateIosPayloadMissingNotificationBody	1415
PushNotificationTemplateMissingDefaultVersion	1418
PushNotificationTemplateMissingName	1442
PushNotificationTemplateMissingPlatformPayload	1411
PushNotificationTemplateNoCustomPayloadForV1	1420
PushNotificationTemplatePayloadContainsInvalidJson	1412
TitleDefaultLanguageNotSet	1393