Request a password reset
API operation: Open the endpoint in Scalar
Use POST /users/forgot to request a password-reset email. The current public operation is User.forgot and does not require an authenticated user.
{
"email": "user@example.com"
}
When the operation accepts a valid request, it queues a reset email. Project settings and request context determine the reset destination; rate limits may restrict repeated requests.
A successful API response confirms that the request was accepted for processing; it does not confirm email delivery or completion of the password reset.
Legacy SDK example
const response = await ordering.users().forgotPassword({email: email})
Confirm the SDK package and version before using this helper.
OpenAPI reference
Operation: POST /users/forgot
Header parameters
| Name | Type | Required | Description |
|---|---|---|---|
X-APP-X | string | No | — |
Origin | string | No | — |
Referer | string | No | — |
X-INTERNAL-PRODUCT-X | string | No | — |
Request body fields
| Name | Type | Required |
|---|---|---|
email | any | No |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized (ProjectAccessErrorResponse) |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |