Anchor to section titled 'undefined'

customerResetByUrl
mutation

Requires unauthenticated_write_customers access scope.

"Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the customerRecover mutation."

Anchor to section titled 'Arguments'

Arguments

Anchor to password
password
String!
required

New password that will be set as part of the reset password process.

Anchor to resetUrl
resetUrl
URL!
required

The customer's reset password url.

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

CustomerResetByUrlPayload returns

Anchor to CustomerResetByUrlPayload.customer
customer
Customer

The customer object which was reset.

Anchor to CustomerResetByUrlPayload.customerAccessToken
customerAccessToken
CustomerAccessToken

A newly created customer access token object for the customer.

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

The list of errors that occurred from executing the mutation.

Anchor to CustomerResetByUrlPayload.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 customerResetByUrl($password: String!, $resetUrl: URL!) {
  customerResetByUrl(password: $password, resetUrl: $resetUrl) {
    customer {
      # Customer fields
    }
    customerAccessToken {
      # CustomerAccessToken fields
    }
    customerUserErrors {
      # CustomerUserError fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "password": "<your-password>",
  "resetUrl": "https://example.myshopify.com"
}