Request a password reset.

POST

/api/auth/v1/reset_password/request

const url = 'https://example.com/api/auth/v1/reset_password/request';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"redirect_uri":"example","email":"example"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/api/auth/v1/reset_password/request \
  --header 'Content-Type: application/json' \
  --data '{ "redirect_uri": "example", "email": "example" }'

Parameters

Query Parameters

redirect_uri

string | null

Request Body^required

application/json

One of:

object
object

object

redirect_uri

string | null

email

required

string

Example^generated

{
  "redirect_uri": "example",
  "email": "example"
}

Responses

200

Success or user not found, when redirect_uri not present.

303

Success or user not found, when redirect_uri present

400

Malformed email address.