Forgot Password

Prev Next
Post
/api/v1/users.forgotPassword

Send an email to reset your password. Ensure that you have completed the configuration of the email; otherwise, your users will not receive the mail normally. Access this from Administration > Workspace > Settings > Email.
To use this endpoint, the PasswordReset setting must be enabled in Settings > Accounts > Registration > Password Reset.

Changelog

Version Description
0.64.0 Added
Body parameters
Example 1
{
  "email": "[email protected]"
}
object
email
string Required

The email to send password reset link.

Example[email protected]
Responses
200
Success Example
{
  "status": "success"
}
object
status
string
400

Bad Request

Example 1
{
  "success": false,
  "error": "The 'email' param is required"
}
object
success
boolean
error
string