For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.

Docs API Reference Learn Community Changelog

Docs API Reference Learn Community Changelog

- About Our APIs
REST
GraphQL
MCP
- Overview

GraphQL Storefront Mutations

requestResetPassword

Example Query

1 mutation ExampleMutation($reCaptchaV2: ReCaptchaV2Input, $input: RequestResetPasswordInput) {
2   requestResetPassword(reCaptchaV2: $reCaptchaV2, input: $input) {
3     errors
4   }
5 }

Variables

1 {
2   "reCaptchaV2": {
3     "token": "example"
4   },
5   "input": {
6     "email": "example",
7     "path": "example"
8   }
9 }

Example response

1 {
2   "data": {
3     "requestResetPassword": {
4       "errors": [
5         {
6           "path": [
7             "example"
8           ],
9           "message": "example"
10         }
11       ]
12     }
13   }
14 }

Request reset password email.

Was this page helpful?

changePassword

resetPassword

Arguments

reCaptchaV2ReCaptchaV2InputOptional

Recaptcha token.

inputRequestResetPasswordInputRequired

Input for the reset password email.

Returns

a RequestResetPasswordResult

errorslist of RequestResetPasswordErrors

The errors, if any, that occured during the request.