Skip to main content
POST
/
frontend
/
api
/
v1
/
auth
/
password-restore
Send password restoration email
curl --request POST \
  --url https://{host}/frontend/api/v1/auth/password-restore \
  --header 'Content-Type: application/json' \
  --header 'X-Recaptcha-Token: <x-recaptcha-token>' \
  --data '
{
  "email": "jsmith@example.com"
}
'
import requests

url = "https://{host}/frontend/api/v1/auth/password-restore"

payload = { "email": "jsmith@example.com" }
headers = {
"X-Recaptcha-Token": "<x-recaptcha-token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {'X-Recaptcha-Token': '<x-recaptcha-token>', 'Content-Type': 'application/json'},
body: JSON.stringify({email: 'jsmith@example.com'})
};

fetch('https://{host}/frontend/api/v1/auth/password-restore', 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://{host}/frontend/api/v1/auth/password-restore",
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' => 'jsmith@example.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Recaptcha-Token: <x-recaptcha-token>"
],
]);

$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://{host}/frontend/api/v1/auth/password-restore"

payload := strings.NewReader("{\n \"email\": \"jsmith@example.com\"\n}")

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

req.Header.Add("X-Recaptcha-Token", "<x-recaptcha-token>")
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://{host}/frontend/api/v1/auth/password-restore")
.header("X-Recaptcha-Token", "<x-recaptcha-token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"jsmith@example.com\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{host}/frontend/api/v1/auth/password-restore")

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

request = Net::HTTP::Post.new(url)
request["X-Recaptcha-Token"] = '<x-recaptcha-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"email\": \"jsmith@example.com\"\n}"

response = http.request(request)
puts response.read_body
{
  "success": true
}

Headers

X-Recaptcha-Token
string
required
Minimum string length: 6

Body

email
string<email>
required
Required string length: 5 - 255

Response

200 - application/json

OK

success
boolean