Choose a version:

customerUpdate

mutation

Requires unauthenticated_write_customers access scope.

Updates a customer's personal information such as name, password, and marketing preferences. Requires a valid CustomerAccessToken to authenticate the customer making the update.

If the customer's password is updated, then all previous access tokens become invalid. The mutation returns a new access token in the payload to maintain the customer's session.

Caution

Password changes invalidate all existing access tokens. Ensure your app handles the new token returned in the response to avoid logging the customer out.

Anchor to Arguments

Arguments

Anchor to customercustomer

•CustomerUpdateInput!

required

The customer object input.

Anchor to customerAccessTokencustomerAccessToken

•String!

required

The access token used to identify the customer.

Was this section helpful?

Anchor to CustomerUpdatePayload returnsCustomerUpdatePayload returns

Anchor to customercustomer •Customer: The updated customer object.
Anchor to customerAccessTokencustomerAccessToken •CustomerAccessToken: The newly created customer access token. If the customer's password is updated, all previous access tokens (including the one used to perform this mutation) become invalid, and a new token is generated.
Anchor to customerUserErrorscustomerUserErrors •[CustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.
Anchor to userErrorsuserErrors •[UserError!]! non-nullDeprecated: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

customerUpdate reference

Mutation Reference

mutation customerUpdate($customerAccessToken: String!, $customer: CustomerUpdateInput!) {

customerUpdate(customerAccessToken: $customerAccessToken, customer: $customer) {

customer {

# Customer fields

}

customerAccessToken {

# CustomerAccessToken fields

}

customerUserErrors {

# CustomerUserError fields

}

Input

{

"customerAccessToken": "<your-customerAccessToken>",

"customer": {

"firstName": "<your-firstName>",

"lastName": "<your-lastName>",

"email": "<your-email>",

"phone": "<your-phone>",

"password": "<your-password>",

"acceptsMarketing": true

}

Variables

{
  "customerAccessToken": "<your-customerAccessToken>",
  "customer": {
    "firstName": "<your-firstName>",
    "lastName": "<your-lastName>",
    "email": "<your-email>",
    "phone": "<your-phone>",
    "password": "<your-password>",
    "acceptsMarketing": true
  }
}

Schema

input CustomerUpdateInput {
  firstName: String
  lastName: String
  email: String
  phone: String
  password: String
  acceptsMarketing: Boolean
}