---
title: "Send the branded password-reset message"
method: POST
path: "/api/users/password-reset-email"
tags: ["Users"]
---

# Send the branded password-reset message

`POST /api/users/password-reset-email`

## Request

- Base URL: `https://api.hiyd.ai`
- URL: `https://api.hiyd.ai/api/users/password-reset-email`
- Auth: one of:
  - HTTP bearer
  - HTTP bearer

Public (the caller is signed out). Answers identically whether or not an account exists for the address, so it cannot be used to discover which emails have hiyd accounts. The link lands on the hosted /auth/reset-password page, where the new password is chosen.

## Request body

- object
  - `email` string, email, required

## Response `200`

Sent if the account exists (the response does not say)

## Other responses

- `400`: Missing or malformed email address
- `429`: Too many requests from this client or for this address
- `503`: No mail provider configured; clients fall back to Firebase

---

[API](https://skmtc.dev/hiyd/apis/hiyd-backend-api.md) - [All operations](https://skmtc.dev/hiyd/apis/hiyd-backend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/hiyd/apis/hiyd-backend-api/revisions/23598d347e1b?raw)