Skip to content
This repository has been archived by the owner on Nov 19, 2024. It is now read-only.

Commit

Permalink
Grammar/style updates
Browse files Browse the repository at this point in the history
  • Loading branch information
keharper authored Jun 18, 2020
1 parent f1dbec4 commit f8d33b5
Showing 1 changed file with 11 additions and 6 deletions.
17 changes: 11 additions & 6 deletions src/guides/v2.4/graphql/mutations/request-password-reset-email.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ contributor_name: Atwix
contributor_link: https://www.atwix.com/
---

The `requestPasswordResetEmail` mutation triggers the password reset email by the provided email address. Use it to initiate a reset password process for the registered customer before [resetPassword]({{page.baseurl}}/graphql/mutations/reset-password.html) mutation call.
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.

## Syntax

Expand Down Expand Up @@ -35,7 +35,7 @@ mutation {
}
```

Customer will receive an email with an URL to reset a password.
Customer will receive an email that contains a URL for resetting their password.

![Reset password email]({{ page.baseurl }}/graphql/images/reset-password-email.png)

Expand All @@ -47,17 +47,22 @@ https://<MAGENTOSITE>/customer/account/createPassword/?token=gh80pkjGdsPyiXc0sUU

## Input arguments

Mutation contains a required `email` argument specified an email of customer.
You must specify the customer's email address in the `email` input argument.

## Output attributes

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`.
The `requestPasswordResetEmail` mutation returns `true` if both of the following operations are successful:

- The reset password operation initiates.
- Magent sends an email containing a reset link.

Otherwise, the mutation returns `false`.

## Errors

Error | Description
--- | ---
`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.
`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.
`The account is locked` | You cannot modify a locked customer account.
`The email address has an invalid format.` | The value provided in the `email` argument has an invalid format.
`You must specify an email address.` | The empty value is provided in the `email` argument.
`You must specify an email address.` | An empty value is provided in the `email` argument.

0 comments on commit f8d33b5

Please sign in to comment.