customerReset mutation
Resets a customer’s password with a token received from CustomerRecover
.
Required access
unauthenticated_write_customers
access scope.
On this page
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
Argument | Description |
---|---|
id
(
ID!
)
required
|
Specifies the customer to reset. |
input
(
CustomerResetInput!
)
required
|
The fields used to reset a customer’s password. |
CustomerResetInput fields
-
password (
String!
) RequiredNew password that will be set as part of the reset password process.
-
resetToken (
String!
) RequiredThe 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
-
userErrors (
[UserError!]!
) deprecatedList 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.
On this page
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
Argument | Description |
---|---|
id
(
ID!
)
required
|
Specifies the customer to reset. |
input
(
CustomerResetInput!
)
required
|
The fields used to reset a customer’s password. |
CustomerResetInput fields
-
password (
String!
) RequiredNew password that will be set as part of the reset password process.
-
resetToken (
String!
) RequiredThe 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
-
userErrors (
[UserError!]!
) deprecatedList 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.
On this page
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
Argument | Description |
---|---|
id
(
ID!
)
required
|
Specifies the customer to reset. |
input
(
CustomerResetInput!
)
required
|
The fields used to reset a customer’s password. |
CustomerResetInput fields
-
password (
String!
) RequiredNew password that will be set as part of the reset password process.
-
resetToken (
String!
) RequiredThe 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
-
userErrors (
[UserError!]!
) deprecatedList 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.
On this page
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
Argument | Description |
---|---|
id
(
ID!
)
required
|
Specifies the customer to reset. |
input
(
CustomerResetInput!
)
required
|
The fields used to reset a customer’s password. |
CustomerResetInput fields
-
password (
String!
) RequiredNew password that will be set as part of the reset password process.
-
resetToken (
String!
) RequiredThe 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
-
userErrors (
[UserError!]!
) deprecatedList 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.
On this page
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
Argument | Description |
---|---|
id
(
ID!
)
required
|
Specifies the customer to reset. |
input
(
CustomerResetInput!
)
required
|
The fields used to reset a customer’s password. |
CustomerResetInput fields
-
password (
String!
) RequiredNew password that will be set as part of the reset password process.
-
resetToken (
String!
) RequiredThe 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
-
userErrors (
[UserError!]!
) deprecatedList 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.
On this page
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
Argument | Description |
---|---|
id
(
ID!
)
required
|
Specifies the customer to reset. |
input
(
CustomerResetInput!
)
required
|
The fields used to reset a customer’s password. |
CustomerResetInput fields
-
password (
String!
) RequiredNew password that will be set as part of the reset password process.
-
resetToken (
String!
) RequiredThe 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
-
userErrors (
[UserError!]!
) deprecatedList 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.
On this page
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
Argument | Description |
---|---|
id
(
ID!
)
required
|
Specifies the customer to reset. |
input
(
CustomerResetInput!
)
required
|
The fields used to reset a customer’s password. |
CustomerResetInput fields
-
password (
String!
) RequiredNew password that will be set as part of the reset password process.
-
resetToken (
String!
) RequiredThe 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
-
userErrors (
[UserError!]!
) deprecatedList 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.
On this page
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
Argument | Description |
---|---|
id
(
ID!
)
required
|
Specifies the customer to reset. |
input
(
CustomerResetInput!
)
required
|
The fields used to reset a customer’s password. |
CustomerResetInput fields
-
password (
String!
) RequiredNew password that will be set as part of the reset password process.
-
resetToken (
String!
) RequiredThe 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
-
userErrors (
[UserError!]!
) deprecatedList 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.
On this page
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
Argument | Description |
---|---|
id
(
ID!
)
required
|
Specifies the customer to reset. |
input
(
CustomerResetInput!
)
required
|
The fields used to reset a customer’s password. |
CustomerResetInput fields
-
password (
String!
) RequiredNew password that will be set as part of the reset password process.
-
resetToken (
String!
) RequiredThe 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
-
userErrors (
[UserError!]!
) deprecatedList of errors that occurred executing the mutation.
Deprecation warning
Use
customerUserErrors
instead