Password Reset

Trigger a password reset email to be sent to the specified email address. This is a public endpoint that does not require authentication.

Parameters

name * are required parameters	data type	description
body.email*	string	The email address of the account to reset

Return Value

Returns HTTP 201 Created after the reset email is queued.

{
  "message": "Password Reset Email Sent",
  "data": true
}

Error Codes

• 400 Bad Request: Malformed Request when email validation fails.
• 400 Bad Request: Email address not found when the email has no Firebase Authentication account.
• 400 Bad Request: User record not found when the authentication account exists but its global user record is missing. No reset link is generated or email queued.
• 400 Bad Request: A reset was requested less than three minutes ago. Wait until the cooldown has elapsed before retrying.
• 500 Internal Server Error: failed to generate reset code when the generated reset link contains no OOB code.

Examples

bash

curl -X POST "https://app.wombat.software/api/password-reset" \
  -H "Content-Type: application/json" \
  -d '{"email": "user@example.com"}'