Documentation

SendCustomAccountRecoveryEmail

Forces an email to be sent to the registered contact email address for the user's account based on an account recovery email template

Request Details

PlayFab accounts which have valid email address or username will be able to receive a password reset email using this API.The email sent must be an account recovery email template. The username or email can be passed in to send the email

SendCustomAccountRecoveryEmailRequest
Request Properties
Email String

User email address attached to their account

EmailTemplateId (required) String

The email template id of the account recovery email template to send.

Username String

The user's username requesting an account recovery.

POST https://{{TitleID}}.playfabapi.com/Server/SendCustomAccountRecoveryEmail
    Content-Type: application/json
    X-SecretKey: <developer_secret_key>
{
  "EmailTemplateId": "D53AB15D8F12E330",
  "Email": "Me@here.com"
}
        

Response Details

SendCustomAccountRecoveryEmailResult
Result Properties

Sample Response

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


Authentication

SecretKey

Possible Error Codes

Name Code
AccountNotFound 1001
EmailClientCanceledTask 1317
EmailClientTimeout 1316
EmailMessageToAddressIsMissing 1310
EmailTemplateMissing 1318
NoContactEmailAddressFound 1325
SmtpAddonNotEnabled 1341