logo
AuthStart the password reset flow

Start the password reset flow

curl -X POST "https://mail.haltman.io/api/auth/forgot-password" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "user@example.com"
}'
{
  "ok": true,
  "action": "forgot_password",
  "accepted": true,
  "recovery": {
    "ttl_minutes": 42
  }
}
POST
/api/auth/forgot-password
POST
Content-Typestring
Required

The media type of the request body

Options: application/json
emailstring
Required
Format: email
Request Preview
Response

Response will appear here after sending the request

Body

application/json

Responses

okboolean
Required
actionstring
Required
Allowed values:forgot_password
acceptedboolean
Required
recoveryobject
Required