Skip to main content
mutation

Requires unauthenticated_write_customers access scope.

Resets a customer's password using the reset token from a password recovery email. On success, returns the updated Customer and a new CustomerAccessToken for immediate authentication.

Use the customerRecover mutation to send the password recovery email that provides the reset token. Alternatively, use customerResetByUrl if you have the full reset URL instead of the customer ID and token.


Caution

This mutation handles sensitive customer credentials. Validate password requirements on the client before submission.


•ID!
required

Specifies the customer to reset.

•CustomerResetInput!
required

The fields used to reset a customer’s password.


Was this section helpful?

Anchor to CustomerResetPayload returnsCustomerResetPayload returns

•Customer

The customer object which was reset.

•CustomerAccessToken

A newly created customer access token object for the customer.

•[CustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

•[UserError!]!
non-nullDeprecated

The list of errors that occurred from executing the mutation.


Was this section helpful?