Account Management - Send Custom Account Recovery Email

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

POST https://titleId.playfabapi.com/Server/SendCustomAccountRecoveryEmail

Request Body

Name Required Type Description
Email
  • string

User email address attached to their account

EmailTemplateId True
  • string

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

Username
  • string

The user's username requesting an account recovery.

Responses

Name Type Description
200 OK
400 Bad Request

This is the outer wrapper for all responses with errors

Security

SecretKey

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

Type: apiKey
In: header

Definitions

ApiErrorWrapper

The basic wrapper around every failed API response

SendCustomAccountRecoveryEmailRequest

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

SendCustomAccountRecoveryEmailResult

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

SendCustomAccountRecoveryEmailRequest

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

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.

Username
  • string

The user's username requesting an account recovery.

SendCustomAccountRecoveryEmailResult

Error Codes

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