Skip to Content
ReferenceStorefrontv1.3.0 API Reference (Latest)InputsCustomerUpdateInput

CustomerUpdateInput

Input for updating an existing customer account

Input Definition

input CustomerUpdateInput {
  firstName: String
  lastName: String
  phone: String
  address1: String
  address2: String
  city: String
  zipcode: String
  country: String
  region: String
  company: String
  vatNumber: String
  companyId: String
  acceptsMarketing: Boolean
  consents: [ConsentInput!]
}

Fields

FieldTypeRequiredDescription
firstNameStringNoThe customer’s first name
lastNameStringNoThe customer’s last name
phoneStringNoThe customer’s phone number
address1StringNoThe first line of the customer’s address
address2StringNoThe second line of the customer’s address
cityStringNoThe customer’s city
zipcodeStringNoThe customer’s postal/zip code
countryStringNoThe customer’s country code (ISO 3166-1 alpha-2)
regionStringNoThe customer’s state/province/region
companyStringNoThe customer’s company name
vatNumberStringNoThe customer’s VAT number
companyIdStringNoThe customer’s company/business ID
acceptsMarketingBooleanNoWhether the customer accepts marketing communications
consents[ConsentInput!]NoConsents to record for the customer (privacy, marketing, cookie policy, or custom types)

Example

mutation {
  updateCustomer(input: {
    firstName: "Jane"
    lastName: "Smith"
    phone: "+1-555-0123"
    address1: "123 Main Street"
    address2: "Suite 100"
    city: "Portland"
    zipcode: "97201"
    country: "US"
    region: "OR"
    company: "Acme Corp"
    vatNumber: "DE123456789"
    companyId: "comp-12345"
    acceptsMarketing: true
    consents: [
      {
        type: "marketing"
        status: "accepted"
      }
    ]
  }) {
    id
    email
    firstName
    lastName
  }
}
  • ConsentInput