Skip to main content
POST
Send Custom Account Recovery Email

Authorizations

X-SecretKey
string
header
required

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

Body

application/json

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

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

EmailTemplateId
string
required

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

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

Username
string

The user's username requesting an account recovery.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 2, 2026