Skip to main content
Anchor to CustomerResetPayload

CustomerResetPayload

payload

Return type for customerReset mutation.

•Customer

The customer object which was reset.

Show fields
•CustomerAccessToken

A newly created customer access token object for the customer.

Show fields
•[CustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Show fields
•[UserError!]!
non-nullDeprecated
Show fields

Was this section helpful?

Anchor to Mutations with this payloadMutations with this payload

•mutation

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.


Show payload

Arguments

•ID!
required

Specifies the customer to reset.

•CustomerResetInput!
required

The fields used to reset a customer’s password.

Show input fields


Was this section helpful?