Anchor to section titled 'undefined'

customerRecover
mutation

Requires unauthenticated_write_customers access scope.

Sends a reset password email to the customer. The reset password email contains a reset password URL and token that you can pass to the customerResetByUrl or customerReset mutation to reset the customer password.

This mutation is throttled by IP. With private access, you can provide a Shopify-Storefront-Buyer-IP instead of the request IP. The header is case-sensitive and must be sent as Shopify-Storefront-Buyer-IP.

Make sure that the value provided to Shopify-Storefront-Buyer-IP is trusted. Unthrottled access to this mutation presents a security risk.

Anchor to section titled 'Arguments'

Arguments

Anchor to email
email
String!
required

The email address of the customer to recover.

Was this section helpful?
Anchor to section titled 'CustomerRecoverPayload returns'

CustomerRecoverPayload returns

Anchor to CustomerRecoverPayload.customerUserErrors
customerUserErrors
[CustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Anchor to CustomerRecoverPayload.userErrors
userErrors
[UserError!]!
non-null
deprecated

The list of errors that occurred from executing the mutation. Use customerUserErrors instead.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerRecover($email: String!) {
  customerRecover(email: $email) {
    customerUserErrors {
      # CustomerUserError fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "email": "<your-email>"
}