Account Management - Send Account Recovery Email

Service:

Admin

API Version:

240412

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/Admin/SendAccountRecoveryEmail

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.

Request Body

Name	Required	Type	Description
Email	True	string	User email address attached to their account
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 account recovery email template to send.

Responses

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

Security

X-SecretKey

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

Type: apiKey
In: header

Definitions

Name	Description
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	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

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
CustomTags	object	The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).
Email	string	User email address attached to their account
EmailTemplateId	string	The email template id of the account recovery email template to send.

SendAccountRecoveryEmailResult

Error Codes

Name	Code
EmailRecipientBlacklisted	1427
InvalidEmailAddress	1005
NoContactEmailAddressFound	1325
SmtpAddonNotEnabled	1341