---
title: "Request a set/reset password link"
method: POST
path: "/v1/auth/password-reset-requests"
tags: ["auth"]
---

# Request a set/reset password link

`POST /v1/auth/password-reset-requests`

## Request

- Base URL: `https://api.patricia.app` (the document declares no server; this is the origin it was published from)
- URL: `https://api.patricia.app/v1/auth/password-reset-requests`
- Auth: none declared

Sends a link that lets the holder of the mailbox choose a password. Answers 202 whether or not the address has an account.

## Request body

- PasswordLinkRequest: Ask for a set-password or reset-password link. Answers identically either way.
  - `email` string, email, required
  - `captcha_token` string

## Response `202`

Always the same acknowledgement.

- AuthEmailAcceptedResponse: The ONE answer both link-request endpoints give, whatever the address. A body that varied by outcome — or a 404 for an unknown address — would turn either endpoint into an account-existence oracle for anyone who can type an email in.
  - `status` 'accepted'

## Other responses

- `400`: Captcha required or rejected — see ``code`` (``CAPTCHA_REQUIRED`` / ``CAPTCHA_REJECTED``)
- `422`: Validation Error
- `429`: Too many attempts against this address (``TOO_MANY_REQUESTS``), or too many requests from this client (``RATE_LIMITED``)
- `502`: Captcha verification unavailable (``CAPTCHA_ERROR``)

---

[API](https://skmtc.dev/patricia/apis/patricia-api.md) · [All operations](https://skmtc.dev/patricia/apis/patricia-api/llms.txt) · [OpenAPI document](https://skmtc.dev/patricia/apis/patricia-api/revisions/0dfb44495ea1?raw)