forgotpassword.md

Forgot Password

Send an email to reset your password.

HTTP Method	URL	Requires Auth
POST	/api/v1/users.forgotPassword	no

{% hint style="info" %} Please ensure that you have completed the configuration of the Email; otherwise, your users will not receive the mail normally. Accessible from Administration -> Email. {% endhint %}

Body Parameters

Key	Example Value	Description
email*	email@rocket.cat	The email to send password reset link.

Example Call

curl -H "Content-type:application/json" \
      http://localhost:3000/api/v1/users.forgotPassword \
      -d '{ 
            "email": "email@rocket.cat" }'

Example Response

{
  "status": "success"
}

Change Log

Version	Description
0.64.0	Added