Choose a version:

customerUpdate

mutation

Requires unauthenticated_write_customers access scope.

Updates an existing customer.

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?

Mutation Reference

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

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

customer {

# Customer fields

}

customerAccessToken {

# CustomerAccessToken fields

}

customerUserErrors {

# CustomerUserError fields

}

userErrors {

field

message

}

Input

{

"customer": {

"acceptsMarketing": true,

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

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

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

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

"phone": "<your-phone>"

"customerAccessToken": "<your-customerAccessToken>"

}

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

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