Skip to main content
POST
/
api
/
v1
/
auth
/
forgot-password
Forgot Password
curl --request POST \
  --url https://api.bunship.com/api/v1/auth/forgot-password \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>"
}
'
{
  "message": "If an account exists with that email, a password reset link has been sent."
}

Documentation Index

Fetch the complete documentation index at: https://docs.bunship.com/llms.txt

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

Sends a password reset link to the provided email address. To prevent email enumeration attacks, this endpoint always returns a success response regardless of whether the email exists in the system.

​
Auth

None required.

​
Rate Limit

20 requests per minute per IP.

​
Request Body

​
email
string
required
The email address associated with the account.

​
Response

​
message
string
Confirmation message. Always returns success to prevent email enumeration.
{
  "message": "If an account exists with that email, a password reset link has been sent."
}

​
Example

curl -X POST https://api.bunship.com/api/v1/auth/forgot-password \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'