Login
    Contents x
    Forgot Password
      • Print
      • Dark
        Light
      • PDF
      Contents

      Forgot Password

        • Print
        • Dark
          Light
        • PDF
        Article summary

        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 > Email inboxes.

        Changelog

        VersionDescription
        0.64.0Added
        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
        Was this article helpful?
        What's Next
        Rocket.Chat versions receive support for six months after release.
        Change password!
        Changing your password will log you out immediately. Use the new password to log back in.
        Change profile
        Success!
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.
        Logout