Request password reset

POST

/api/v1/auth/reset

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

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/v1/auth/reset \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com" }'

Sends a password reset email

Request Body^required

application/json

object

email

required

string format: email

Example ^generated

{
  "email": "hello@example.com"
}

Responses

200

Password reset email sent

400

Bad Request

500

Internal Server Error

Request password reset

Request Body required

Example generated

Responses

200

400

500

Request Body^required

Example ^generated