POST /auth/forgot-password

Forgot Password will send an email to the user with a link to reset the password

Headers

  • X-Popsell-Domain string Required

    The domain of the user

application/json

Body

  • email string Required

Responses

  • 200 application/json

    Return a message to confirm the email was sent

    Hide response attribute Show response attribute object
    • message string
  • 429 application/json

    Too Many Request

    Hide response attribute Show response attribute object
    • message string
POST /auth/forgot-password
curl \
 --request POST 'https://domain.tld/api/v2/auth/forgot-password' \
 --header "Content-Type: application/json" \
 --header "X-Popsell-Domain: example.com" \
 --data '{"email":"string"}'
Request examples
# Headers
X-Popsell-Domain: example.com

# Payload
{
  "email": "string"
}
Response examples (200)
{
  "message": "Reset password link sent"
}
Response examples (429)
{
  "message": "Too Many Requests."
}