Send a Password Reset Email

Sends a password reset email to the specified email address.

Request URL

POST {base_url}/uc-user/api/v1/public/users/password/forgot

Request parameters

Body parameters
Parameter Required Type Description
email Yes String The email address of the account.
captchaId Yes String The ID of the captcha, which is obtained from the captcha generation API and identifies the captcha session.
captchaCode Yes String The captcha code entered by the user.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Object<Forgot_Password_Result> The result of sending the password reset email.
Forgot_Password_Result
Parameter Type Description
success Boolean Whether the password reset email is sent successfully.
message String The prompt message.