XM
Powered By GitBook
Reset Password
Path:
1
PATCH https://{baseurl}/api-commerceIdentity/auth/local/reset/token
Copied!
To prevent a common pitfall of cart abandonment due to password reset issues, we offer a simple and straightforward option to reset password. Your customers will receive a reset password link in their email. By clicking the link, they can go ahead to change their password through the Update Password API.
Headers
Content-Type : application/json
x-site-context : { "date": "2020-08-28T02:35:27.787Z", "channel": 12, "account": 5f493c9f30ec2a0007a94fc8", "stage": "sandbox" }

Parameters

Type : requestBody
Name : The email address
Required: true

Sample Request

1
{
2
"username" : "[email protected]",
3
}
Copied!

Response

HTTP Code : 200 Message : OK
Description: You will see this message when the password reset is initiated (link is sent to the user's registered email address).
Sample
1
{
2
"name": "John Doe",
3
"resetLink": "http://localhost:3000/resetpassword/5e97e4873cb8553c0e43d88e",
4
"email": "[email protected]",
5
"emailSent": true
6
}
Copied!
HTTP Code : 404 Message : Not Found
Description: You'll see this message when the email address provided is incorrect.
Sample
1
{
2
"code": "USER_NOT_FOUND",
3
"message": "User not found."
4
}
Copied!

Changelog

    Last updated - July 2020
Last modified 3mo ago
Copy link
Contents
Changelog