Skip to main content
POST
/
api
/
v1
/
auth
/
forgot-password
Forgot Password
curl --request POST \
  --url https://api.example.com/api/v1/auth/forgot-password \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "account": "<string>"
}
'
{
  "message": "<string>"
}

Body

application/json

Request body for forgot password.

​
email
string<email>
required

User's email address

​
account
string
required

Account identifier (slug or ID in XX#### format)

Minimum string length: 1

Response

Password reset email sent (or email not found - same response)

Response for forgot password request.

​
message
string
required

Success message (always returned regardless of whether email exists)