Send reset password email
POST/user/reset_password
Sends a one-time reset code to the user's registered email address. The code must
then be supplied to PUT /user/reset_password together with the new password.
Requirements
- Password reset must be enabled in the plugin settings.
- If "Reset Password Requires Auth Code" is enabled,
AUTH_KEYmust be provided. - The email address must belong to an existing WordPress user.
Flow
- Call
POST /user/reset_passwordwithemail(andAUTH_KEYif required). - The user receives an email containing a one-time
code. - Call
PUT /user/reset_passwordwithemail,code, andnew_password.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 500
Reset password email sent successfully.
Unauthorized. The provided auth code is wrong (error_code 27).
Forbidden. Password reset is disabled in the plugin settings (error_code 56).
No WordPress user with the provided email address was found.
Unprocessable entity. One of:
- The
emailfield is missing (error_code63). - The email address format is invalid (
error_code96). - The auth code is required but was not provided (
error_code94).
Internal server error (e.g. email sending failure).