Comment on page

Forgot Password

Send email to reset your password.

URL
Requires Auth
HTTP Method
/api/v1/users.forgotPassword
no
POST
Note
Please ensure that you have completed the configuration of the Email; otherwise, your users will not receive the mail normally. Accessible from Administration -> Email.
Payload
Argument
Example
Required
Description
email
[email protected]
Required
The email to send password reset link
Example Call - As JSON
curl -H "Content-type:application/json" \
      http://localhost:3000/api/v1/users.forgotPassword \
      -d '{ "email": "[email protected]" }'
Result
{
  "status": "success"
}
Change Log
Version
Description
0.64.0
Added

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

Argument	Example	Required	Description
`email`	`[email protected]`	Required	The email to send password reset link

Version	Description
0.64.0	Added

Last modified 1yr ago