Enviar email de recuperação de conta

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.

Error codes

This operation may return the following PlayFab errors:

Error	Code
EmailRecipientBlacklisted	1427
InvalidEmailAddress	1005
NoContactEmailAddressFound	1325
SmtpAddonNotEnabled	1341

POST

Admin

SendAccountRecoveryEmail

Send Account Recovery Email

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "Email": "assignedemail@here.com",
  "EmailTemplateId": "D53AB15D8F12E330"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail"

payload = {
    "Email": "assignedemail@here.com",
    "EmailTemplateId": "D53AB15D8F12E330"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Email: 'assignedemail@here.com', EmailTemplateId: 'D53AB15D8F12E330'})
};

fetch('https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Email' => 'assignedemail@here.com',
    'EmailTemplateId' => 'D53AB15D8F12E330'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail"

	payload := strings.NewReader("{\n  \"Email\": \"assignedemail@here.com\",\n  \"EmailTemplateId\": \"D53AB15D8F12E330\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Email\": \"assignedemail@here.com\",\n  \"EmailTemplateId\": \"D53AB15D8F12E330\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Email\": \"assignedemail@here.com\",\n  \"EmailTemplateId\": \"D53AB15D8F12E330\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

Autorizações

X-SecretKey

string

header

obrigatório

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

Corpo

application/json

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.

string

obrigatório

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.

Resposta

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

Última modificação em 6 de outubro de 2026

Tópicos relacionados

Enviar email de recuperação de conta Enviar email personalizado de recuperação de conta Usar modelos de email para enviar um email de recuperação de conta Usar uma regra para verificar um endereço de email de contato Enviar email a partir de modelo

⌘I

Send Account Recovery Email

curl --request POST \
  --url https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail \
  --header 'Content-Type: application/json' \
  --header 'X-SecretKey: <api-key>' \
  --data '
{
  "Email": "assignedemail@here.com",
  "EmailTemplateId": "D53AB15D8F12E330"
}
'

import requests

url = "https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail"

payload = {
    "Email": "assignedemail@here.com",
    "EmailTemplateId": "D53AB15D8F12E330"
}
headers = {
    "X-SecretKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-SecretKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({Email: 'assignedemail@here.com', EmailTemplateId: 'D53AB15D8F12E330'})
};

fetch('https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'Email' => 'assignedemail@here.com',
    'EmailTemplateId' => 'D53AB15D8F12E330'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-SecretKey: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail"

	payload := strings.NewReader("{\n  \"Email\": \"assignedemail@here.com\",\n  \"EmailTemplateId\": \"D53AB15D8F12E330\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-SecretKey", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail")
  .header("X-SecretKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"Email\": \"assignedemail@here.com\",\n  \"EmailTemplateId\": \"D53AB15D8F12E330\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{titleId}.playfabapi.com/Admin/SendAccountRecoveryEmail")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-SecretKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"Email\": \"assignedemail@here.com\",\n  \"EmailTemplateId\": \"D53AB15D8F12E330\"\n}"

response = http.request(request)
puts response.read_body

{
  "code": 123,
  "status": "<string>",
  "data": {}
}

{
  "code": 123,
  "errorCode": 123,
  "status": "<string>",
  "error": "<string>",
  "errorMessage": "<string>",
  "errorDetails": {}
}

PlayFab API

PlayFab REST API References

Enviar email de recuperação de conta

Error codes

Autorizações

Corpo

Resposta