POST
/
auth
/
forgot-password
Forgot Password
curl --request POST \
  --url https://{deploymentHost}/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "user@example.com"
}'
{
  "status": 200,
  "message": "",
  "data": {
    "message": "If an account with this email exists, a password reset link has been sent."
  },
  "session": {
    "signin_attempts": [],
    "signins": [],
    "signup_attempts": [],
    "active_signin": null
  },
  "errors": []
}

Authorizations

​
__session
string
cookie
required

Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.

Body

application/json

Response

200
application/json

Password reset email sent (always returns success for security)

The response is of type object.