v1

latestOpenAPI 3.0.3raw.githubusercontent.com2024-10-2916802.4 MB
🔐 Authentication

Forgot password request

The API endpoint allows you to send a forgot password email by providing the user's email ID.

When accessing this endpoint and providing the email ID as a parameter, the API initiates the process of sending a password reset email to the specified email address.

This functionality is useful for implementing password recovery mechanisms within your application, allowing users to reset their passwords securely.

post/users/forgot-password

Request body

emailstring

Example request

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

Response

Forgot password request

dataobject
messagestring
statusCodenumber
successboolean

Example response

{
  "message": "Password reset mail has been sent on your mail id",
  "statusCode": 200,
  "success": true
}