Account Management - Send Account Recovery Email

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.

POST https://titleId.playfabapi.com/Client/SendAccountRecoveryEmail

Request Body

Name Required Type Description
Email True
  • string

User email address attached to their account

EmailTemplateId
  • string

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

PublisherId
  • string

Deprecated - Do not use

TitleId True
  • string

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

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer-wrapper for all responses with errors

Security

None

This API requires no authentication headers (usually provides one to other calls).

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

SendAccountRecoveryEmailRequest

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.

SendAccountRecoveryEmailResult

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code
  • number

Numerical HTTP code

error
  • string

Playfab error code

errorCode
  • number

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

SendAccountRecoveryEmailRequest

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.

Name Type Description
Email
  • string

User email address attached to their account

EmailTemplateId
  • string

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

PublisherId
  • string

Deprecated - Do not use

TitleId
  • string

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

SendAccountRecoveryEmailResult

Error Codes

Name Code
AccountNotFound 1001
NoContactEmailAddressFound 1325
SmtpAddonNotEnabled 1341