Account Management - Send Email From Template

Sends an email based on an email template to a player's contact email

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

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.

Name	Required	Type	Description
EmailTemplateId	True	string	The email template id of the email template to send.
PlayFabId	True	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.
CustomTags		object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

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

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

Type: apiKey
In: header

Name	Description
ApiErrorWrapper	The basic wrapper around every failed API response
SendEmailFromTemplateRequest	Sends an email for only players that have contact emails associated with them. Takes in an email template ID specifyingthe email template to send.
SendEmailFromTemplateResult

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

Sends an email for only players that have contact emails associated with them. Takes in an email template ID specifyingthe email template to send.

Name	Type	Description
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
EmailTemplateId	string	The email template id of the email template to send.
PlayFabId	string	Unique PlayFab assigned ID of the user on whom the operation will be performed.

Name	Code
EmailClientCanceledTask	1317
EmailClientTimeout	1316
EmailTemplateMissing	1318
NoContactEmailAddressFound	1325
SmtpAddonNotEnabled	1341