POST/api/auth/forgot-password

Starts a password reset: if an account with the given email address exists, it receives an email with a reset link.

Send the account's email address in the `email` field. The response `{"ok":true}` is deliberately always the same – regardless of whether an account exists – so that this endpoint cannot be used to find out which addresses are registered. The new password is then set with the token from the email via `POST /api/auth/reset-password`. If the `email` field is missing or empty, the endpoint responds with 400 `VALIDATION_ERROR`. To prevent abuse, the number of requests per IP address is limited (429 `RATE_LIMIT_EXCEEDED`).

Overview

Call: POST /api/auth/forgot-password. This endpoint belongs to the “Authentication” group of the Zentor App API. It is publicly accessible and requires no authentication. The call is idempotent: repeating it with the same input returns the same result. Required parameters: email (body). Documented error cases: 400 VALIDATION_ERROR. The example response below shows the structure of a successful JSON response.

Auth & Security

No authentication required

Idempotent: Yes

Parameters

email(body, string, required)— Email address of the account

Example Request

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

Example Response

{"ok":true}

Error Codes

400 VALIDATION_ERROR — The `email` field is missing or empty.

Verified behaviour

The response is 200 `{"ok":true}` regardless of whether the account exists; a missing email field returns 400 `VALIDATION_ERROR`.

Authentication

Related articles

← Authentication