customerPasswordResetRequest

Mutationin Authentication

Request a password reset email for the given email address

Arguments

Argument	Type	Description
`email`	`EmailAddress!`

Returns

CustomerPasswordResetRequestResponse!

Field	Type	Description
`success`	`Boolean!`	Indicates if the password reset request was successful
`customerErrors`	`[CustomerPasswordResetRequestError!]`	Error details if the request failed

Example

Query
Response

mutation {
  customerPasswordResetRequest(email: "john.doe@example.com") {
    success
    customerErrors {
      ... on ValidationError {
        message
      }
    }
  }
}

{
  "data": {
    "customerPasswordResetRequest": {
      "success": true,
      "customerErrors": [
        {
          "message": "Example"
        }
      ]
    }
  }
}

The query is the example the schema documents. The response shows its shape with placeholder values.

Served by

@evolve-framework/commercetools	Resolved
@evolve-framework/medusa	Resolved
@evolve-framework/sfcc	Stub: answers Not implemented

Used by

The storefront packages that send it, in these GraphQL documents:

@evolve-storefront/feature-auth: CustomerPasswordResetRequest