You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 19, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: src/guides/v2.4/graphql/mutations/request-password-reset-email.md
+11-6Lines changed: 11 additions & 6 deletions
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ contributor_name: Atwix
5
5
contributor_link: https://www.atwix.com/
6
6
---
7
7
8
-
The `requestPasswordResetEmail` mutation triggers the password reset email by the provided email address. Use it to initiate a reset password process for the registered customerbefore [resetPassword]({{page.baseurl}}/graphql/mutations/reset-password.html) mutation call.
8
+
The `requestPasswordResetEmail` mutation triggers the password reset email by the provided email address. Use it to initiate the process to reset the registered customer's password before calling the [resetPassword]({{page.baseurl}}/graphql/mutations/reset-password.html) mutation.
9
9
10
10
## Syntax
11
11
@@ -35,7 +35,7 @@ mutation {
35
35
}
36
36
```
37
37
38
-
Customer will receive an email with an URL to reset a password.
38
+
Customer will receive an email that contains a URL for resetting their password.
Mutation contains a required `email` argument specified an email of customer.
50
+
You must specify the customer's email address in the `email` input argument.
51
51
52
52
## Output attributes
53
53
54
-
The `requestPasswordResetEmail` mutation returns `true` if reset password operation has been successfully initiated and email with a reset link has been sent. Otherwise returns `false`.
54
+
The `requestPasswordResetEmail` mutation returns `true` if both of the following operations are successful:
55
+
56
+
- The reset password operation initiates.
57
+
- Magent sends an email containing a reset link.
58
+
59
+
Otherwise, the mutation returns `false`.
55
60
56
61
## Errors
57
62
58
63
Error | Description
59
64
--- | ---
60
-
`Cannot reset the customer's password` | General error message which appears on some internal system errors. The original error is logged and can be found in Magento logs.
65
+
`Cannot reset the customer's password` | A general error message that appears on some internal system errors. The original error is logged and can be found in the Magento logs.
61
66
`The account is locked` | You cannot modify a locked customer account.
62
67
`The email address has an invalid format.` | The value provided in the `email` argument has an invalid format.
63
-
`You must specify an email address.` | The empty value is provided in the `email` argument.
68
+
`You must specify an email address.` | An empty value is provided in the `email` argument.
0 commit comments