This endpoint is only to be used on the forgot password page to request a password reset

POST/api/auth/request-password-reset

Request body

requiredapplication/json

emailstringrequired

Responses

200OK

any

500Internal Server Error

any

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Bodyapplication/json

emailstring*

Request

curl -X POST "http://localhost:8000/api/auth/request-password-reset" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "string"
}'

const response = await fetch("http://localhost:8000/api/auth/request-password-reset", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"email\": \"string\"\n}"
});

Response

{
  "message": "Please check your email and password"
}

{
  "message": "Something went wrong",
  "error": "Internal Server Error",
  "statusCode": 500
}