Skip to main content
Anchor to customerRecover

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 Arguments

Arguments

Anchor to emailemail
•String!required

The email address of the customer to recover.

Was this section helpful?

Anchor to CustomerRecoverPayload returnsCustomerRecoverPayload returns

Anchor to customerUserErrorscustomerUserErrors
•[CustomerUserError!]!non-null

The list of errors that occurred from executing the mutation.

Anchor to userErrorsuserErrors
•[UserError!]!non-nullDeprecated

The list of errors that occurred from executing the mutation.

Was this section helpful?