Skip to main content

Documentation Index

Fetch the complete documentation index at: https://api.docs.onlydrams.app/llms.txt

Use this file to discover all available pages before exploring further.

Sends password reset instructions to the user’s registered email address. This endpoint does not require authentication.

​
Endpoint

POST /api/v1/users/recover

​
Request Body

​
user.email
string
required
The email address associated with the user account.
curl -X POST https://api.onlydrams.app/api/v1/users/recover \
  -H "Content-Type: application/json" \
  -d '{
    "user": {
      "email": "user@example.com"
    }
  }'

{
  "message": "An email has been sent to user@example.com."
}

{
  "message": "An email has been sent to user@example.com."
}

​
Notes

  • The response is the same whether the email exists or not (security best practice)
  • If the email exists, password reset instructions will be sent
  • If the email doesn’t exist, no email will be sent but the same response is returned
  • Rate limiting may apply to prevent abuse