Forces an email to be sent to the registered email address for the user's account, with a link allowing the user to change the password.If an account recovery email template ID is provided, an email using the custom email template will be used.

Request Details

If the account in question is a "temporary" account (for example, one that was created via a call to LoginFromIOSDeviceID), thisfunction will have no effect. Only PlayFab accounts which have valid email addresses will be able to receive a password reset email using this API.

Request Properties
Email (required) String

User email address attached to their account

EmailTemplateId String

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

TitleId (required) String

Unique identifier for the title, found in the Settings > Game Properties section of the PlayFab developer site when a title has been selected.

POST https://{{TitleID}}
    Content-Type: application/json
  "Email": "",
  "TitleId": "1000",
  "EmailTemplateId": "D53AB15D8F12E330"

Response Details

Result Properties

Sample Response

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



Possible Error Codes

Name Code
AccountNotFound 1001
NoContactEmailAddressFound 1325
SmtpAddonNotEnabled 1341