POST
/
auth
/
forgot-password
Forgot password
curl --request POST \
  --url https://staging.api.commercengine.io/api/v1/{store_id}/storefront/auth/forgot-password \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "<string>",
  "phone": "<string>",
  "country_code": "<string>"
}'
{
  "message": "<string>",
  "success": true,
  "content": {
    "otp_token": "<string>"
  }
}

Authorizations

Authorization
string
header
required

Access token

Body

application/json
email
string
required

A string representing the email address.

phone
string
required

10 digit phone number without country code.

country_code
string
required

Two-letter code begin with a plus sign prefix that identifies different countries. By default it will be +91 if not provided. Use this key along with phone. Not necessary for email.

Response

OK

message
string
required

A descriptive message confirming the success or failure of the operation.

success
boolean
required

Indicates whether the request was successful or failure (true for success, false for failure).

content
object
required

An object containing the response content.