Skip to content

Latest commit

 

History

History
38 lines (29 loc) · 2.88 KB

update-customer-request.md

File metadata and controls

38 lines (29 loc) · 2.88 KB
Raw

Update Customer Request

Defines the body parameters that can be included in a request to the UpdateCustomer endpoint.

Structure

UpdateCustomerRequest

Fields

Name Type Tags Description
givenName string | undefined Optional The given name (that is, the first name) associated with the customer profile.
familyName string | undefined Optional The family name (that is, the last name) associated with the customer profile.
companyName string | undefined Optional A business name associated with the customer profile.
nickname string | undefined Optional A nickname for the customer profile.
emailAddress string | undefined Optional The email address associated with the customer profile.
address Address | undefined Optional Represents a postal address in a country.
For more information, see Working with Addresses.
phoneNumber string | undefined Optional The phone number associated with the customer profile. A phone number can contain 9–16 digits, with an optional + prefix.
referenceId string | undefined Optional An optional second ID used to associate the customer profile with an
entity in another system.
note string | undefined Optional A custom note associated with the customer profile.
birthday string | undefined Optional The birthday associated with the customer profile, in RFC 3339 format. The year is optional. The timezone and time are not allowed.
For example, 0000-09-21T00:00:00-00:00 represents a birthday on September 21 and 1998-09-21T00:00:00-00:00 represents a birthday on September 21, 1998.
You can also specify this value in YYYY-MM-DD format.
version bigint | undefined Optional The current version of the customer profile.

As a best practice, you should include this field to enable optimistic concurrency control. For more information, see Update a customer profile.
taxIds CustomerTaxIds | undefined Optional Represents the tax ID associated with a customer profile. The corresponding tax_ids field is available only for customers of sellers in EU countries or the United Kingdom.
For more information, see Customer tax IDs.

Example (as JSON)

{
  "email_address": "[email protected]",
  "note": "updated customer note",
  "phone_number": "",
  "version": 2
}