Skip to main content
POST
/
auth
/
forgot-password
Forgot Password
curl --request POST \
  --url https://{deploymentHost}/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --cookie __session= \
  --data '
{
  "email": "[email protected]"
}
'
{
  "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
​
email
string<email>
required

Email address to send password reset link

Response

Password reset email sent (always returns success for security)

​
status
integer
required

HTTP status code

​
message
string
required

Response message (empty for success)

​
data
any
required

Response data (can be any type)

​
session
object
required
​
errors
object[]
required

Array of error objects (empty for success)