Skip to main content

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.