Forgot Password (public)

POST /auth/forgot-password

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

Headers

application/json

Body

Responses

  • 200 application/json

    Return a message to confirm the email was sent

    Hide response attribute Show response attribute object
  • 401 application/json

    Unauthorized.

    Hide response attribute Show response attribute object
  • 422 application/json

    Unprocessable Content

    Hide response attributes Show response attributes object
    • message string

      Error message.

    • errors object
      Hide errors attributes Show errors attributes object
      • field array[string]

        Error message details.

      • * array[string] Additional properties

        Error message details.
  • 429 application/json

    Too Many Request

    Hide response attribute Show response attribute object
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 (401) 
{
  "message": "Unauthorized."
}
Response examples (422) 
{
  "message": "field is required! (and 3 more error)",
  "errors": {
    "field": [
      "Error message details here"
    ],
    "additionalProperty1": [
      "Error message details here"
    ],
    "additionalProperty2": [
      "Error message details here"
    ]
  }
}
Response examples (429) 
{
  "message": "Too Many Requests."
}