API ReferenceAuthentication APIPOST /auth/reset-password-request

POST /auth/reset-password-request

Send a password reset link to the user’s email. The user clicks the link and then submits a new password via POST /auth/reset-password.

Security: For privacy, the response does not reveal whether the email exists. Rate limiting applies per email and IP.

Endpoint

POST /api/v1/public/projects/:projectSlug/auth/reset-password-request

Request Parameters

Path Parameters

ParameterTypeRequiredDescription
projectSlugstringYour project’s unique slug

Request Body

FieldTypeRequiredDescription
emailstringUser’s email address

Example Request Body

{
  "email": "user@example.com"
}

Response

Success (200 OK)

{
  "status": "ok"
}

If the email is registered, a reset link is sent. The response is the same whether the email exists or not (to prevent email enumeration).

Error Responses

Status CodeError CodeDescription
400INVALID_REQUESTInvalid email
429RATE_LIMIT_EXCEEDEDToo many requests
500INTERNAL_SERVER_ERRORServer error

Available Hooks

  • Event: auth.password.reset.requested
    • When: After reset email is sent (or would be sent for existing user)
    • Can do: Security logging, audit trails, user notifications

Configure in Project → Hooks. Learn more about hooks →

Try It Now

POSThttps://api.aerocall.app/api/v1/public/projects/your-project/auth/reset-password-request