Forgot Password

Developing

POST

/auth/forget-password

Forget Password

📣 This endpoint receives a POST request with payload of email address of which the password has been forgotted . The API will send a verification OTP to the respected email

{
  "email": "skshahra@gmail.com"
}

🔰 Each payload in details of this POST Request,

Email: A required string field for the user's email address with a length between 5 and 100 characters and a valid email format.

📢 Info message : Here the POST request enpoint is constructed like /v1/auth/forget-password

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

object {0}

Example

{
    "email": "skshahra@gmail.com"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:8080/v1/auth/forget-password' \
--header 'Content-Type: application/json' \
--data-raw '{
    "email": "skshahra@gmail.com"
}'

Responses

🟢201Created

application/json

Body

message

string

required

success

boolean

required

Example

{"message":"OTPSent Successfully","success":true}

Modified at 2024-09-09 10:30:31

Verify-email

Forgot Password Verify OTP

Forgot Password

Forget Password#

Request

Request samples

Responses

Forget Password