Request Password Reset
POST
/v1/users/forgot-password
const url = 'https://example.com/api/v1/users/forgot-password';const options = { method: 'POST', headers: {'Content-Type': 'application/json'}, body: '{"email":"user@example.com"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://example.com/api/v1/users/forgot-password \ --header 'Content-Type: application/json' \ --data '{ "email": "user@example.com" }'Sends a password reset email if the address is associated with a local account. Always returns 204 on success to avoid leaking whether the email is registered.
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
email
required
string
Example
user@example.comResponses
Section titled “Responses”No Content
Missing or invalid request body, or empty email field
Media typeapplication/json
string
Examplegenerated
exampleDemo mode is enabled or local login is disabled
Media typeapplication/json
string
Examplegenerated
exampleInternal error while processing the request
Media typeapplication/json
string
Examplegenerated
example