namecheap.users.resetPassword

When you call this API, a link to reset password will be emailed to the end user's profile email id.The end user needs to click on the link to reset password.

NOTE: Global parameter - UserName should be omitted for this API call.All other Global parameters must be included.

Request Parameters

Global parameters are not shown here for clarity

Name Type MaxLength Required? Default Description
FindBy String 20 Yes   Possible values:EMAILADDRESS, DOMAINNAME,USERNAME
FindByValue String 20 Yes   The username/email address/domain of the user.
EmailFromName String 20 No namecheap.com Enter a different value to overwrite the default value
EmailFrom String 20 No support@namecheap.com Enter a different value to overwrite the default value
URLPattern String 20 No http://namecheap.com [RESETCODE] Enter a different URL to overwrite namecheap.com. Refer Example Request#2

Example Request 1

https://api.namecheap.com/xml.response?APIUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&
clientip=61.11.95.68&command=namecheap.users.resetpassword&findby=username&findbyvalue=sampleuser

Example Request 2

https://api.namecheap.com/xml.response?APIUser=apiexample&ApiKey=56b4c87ef4fd49cb96d915c0db68194&
clientip=61.11.95.68&command=namecheap.users.resetpassword&findby=username&findbyvalue=sampleuser
&URLPattern=http://www.somedomain.com/ownformat/resetpassword/[RESETCODE]&
EmailFromName=sampleusername&EmailFrom=sampleuser@somedomain.com

Example Response

<?xml version="1.0" encoding="utf-8"?>
<ApiResponse Status="OK" xmlns="http://api.namecheap.com/xml.response">
 <Errors />
 <RequestedCommand>namecheap.users.resetPassword</RequestedCommand>
 <CommandResponse Type="namecheap.users.resetPassword">
   <UserResetPasswordResult Success="true">
     <Email>contact@useremail.com</Email>
   </UserResetPasswordResult>
 </CommandResponse>
<Server>SERVER159</Server>
<GMTTimeDifference>--5:00</GMTTimeDifference>
<ExecutionTime>0.742</ExecutionTime>
</ApiResponse>

Error Codes

Specifies the error codes that might be returned from this method

Number Description
2011315 FindBy is invalid
4027153 Failed to send email
4022335 Unable to reset password
5050900 Unknown exceptions

Comments

Comments

Support requests, bug reports, and off-topic comments will be deleted without warning.

Please do post corrections or additional information/ pointers for this article below. We aim to quickly move corrections into the documentation. Also, your comments may take some time to appear.

If you need specific help with your account, please contact Support

close
Left side occasional ads will now show here with an option to close and don't show again.

Need help? We're always here for you.

× Close