Skip to content

Request password reset

POST
/v1/auth/forgot-password

Send an email with a password-reset link, if an account exists for the address you give. The response is identical either way, so this can't be used to check which emails are registered.

Request Body

application/json

Forgot-password payload (POST /auth/forgot-password) — the email to send a reset link to.

The address to send a password-reset link to.

Responses

OK

application/json

Success body for POST /auth/forgot-password. Deliberately identical whether or
not the email maps to an account, so it can't be used to probe which addresses are registered.

A human-readable confirmation to show the caller.

Playground

Server
Body

Samples

Powered by VitePress OpenAPI