Skip to content

Forgot Password

Send a password reset email to the user's email address.

Interface Information

  • Endpoint: POST /api/auth/forget-password
  • Authentication: Not required
  • Content-Type: application/json

Request Parameters

ParameterTypeRequiredDescription
emailstringYesUser email address

Request Example

bash
curl -X POST http://localhost:3000/api/auth/forget-password \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com"
  }'

Response Example

json
{
  "success": true,
  "message": "Password reset email has been sent"
}

Error Responses

HTTP Status CodeDescription
400Invalid email address
404Email not registered
500Server error