Skip to main content

Forgot Password API

Overview​

Generates a 10-character password reset token and sets a 10-minute expiration timestamp (resetPasswordTime). Sends an email to the user with a link to the frontend password reset page.

  • Endpoint: /api/auth/forgot-password
  • Method: POST or GET
  • Auth Required: No (Public)

Request Parameters (Body / Query)​

FieldTypeRequiredDescription
emailStringYesRegistered user email address

Example Request Body​

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

Responses​

Response (200 OK)​

{
  "success": true,
  "message": "Email Sent",
  "data": null
}

Error Response (400 Bad Request)​

{
  "success": false,
  "message": "User not found",
  "data": null
}