customerReset mutation

Resets a customer’s password with a token received from CustomerRecover.

Required access

unauthenticated_write_customers access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

Specifies the customer to reset.

input ( CustomerResetInput! ) required

CustomerResetInput fields

password (String!) Required

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

resetToken (String!) Required

The reset token required to reset the customer’s password.

Return fields

customer (Customer)

The customer object which was reset.

customerAccessToken (CustomerAccessToken)

A newly created customer access token object for the customer.

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead

Resets a customer’s password with a token received from CustomerRecover.

Required access

unauthenticated_write_customers access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

Specifies the customer to reset.

input ( CustomerResetInput! ) required

CustomerResetInput fields

password (String!) Required

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

resetToken (String!) Required

The reset token required to reset the customer’s password.

Return fields

customer (Customer)

The customer object which was reset.

customerAccessToken (CustomerAccessToken)

A newly created customer access token object for the customer.

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead

Resets a customer’s password with a token received from CustomerRecover.

Required access

unauthenticated_write_customers access scope

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.


Arguments

id ( ID! ) required

Specifies the customer to reset.

input ( CustomerResetInput! ) required

CustomerResetInput fields

password (String!) Required

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

resetToken (String!) Required

The reset token required to reset the customer’s password.

Return fields

customer (Customer)

The customer object which was reset.

customerAccessToken (CustomerAccessToken)

A newly created customer access token object for the customer.

customerUserErrors ([CustomerUserError!]!)

List of errors that occurred executing the mutation.

Deprecated return fields

Show/Hide
userErrors ([UserError!]!) deprecated

List of errors that occurred executing the mutation.

Deprecation warning

Use customerUserErrors instead

Sign up for a Partner account to get started.

Sign up