Documentation

SendEmailFromTemplate

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

Request Details

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

SendEmailFromTemplateRequest
Request Properties
EmailTemplateId (required) String

The email template id of the email template to send.

PlayFabId (required) String

Unique PlayFab assigned ID of the user on whom the operation will be performed.

POST https://{{TitleID}}.playfabapi.com/Server/SendEmailFromTemplate
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "EmailTemplateId": "B53CA15D92D2E331",
  "PlayFabId": "A01DC15D8E12E230"
}
        

Response Details

SendEmailFromTemplateResult
Result Properties

Sample Response

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


Authentication

SecretKey

Possible Error Codes

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