Sign in

v1

latestOpenAPI 3.0.0Apache 2.02026-07-142008071.1 MB
Customers

UpdateCustomer

Updates a customer profile. To change an attribute, specify the new value. To remove an attribute, specify the value as an empty string or empty object.

As a best practice, you should include the version field in the request to enable optimistic concurrency control. The value must be set to the current version of the customer profile.

To update a customer profile that was created by merging existing profiles, you must use the ID of the newly created profile.

You cannot use this endpoint to change cards on file. To make changes, use the Cards API or Gift Cards API.

put/v2/customers/{customer_id}

Path parameters

customer_idstring required

The ID of the customer to update.

Request body

birthdaystring

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.

company_namestring

A business name associated with the customer profile.

email_addressstring

The email address associated with the customer profile.

family_namestring

The family name (that is, the last name) associated with the customer profile.

given_namestring

The given name (that is, the first name) associated with the customer profile.

nicknamestring

A nickname for the customer profile.

notestring

A custom note associated with the customer profile.

phone_numberstring

The 11-digit phone number associated with the customer profile.

reference_idstring

An optional second ID used to associate the customer profile with an entity in another system.

versioninteger

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.

Example request

{
  "request_body": {
    "email_address": "New.Amelia.Earhart@example.com",
    "note": "updated customer note",
    "phone_number": "",
    "version": 2
  }
}

Response

Success

Example response

{
  "customer": {
    "address": {
      "address_line_1": "500 Electric Ave",
      "address_line_2": "Suite 600",
      "administrative_district_level_1": "NY",
      "country": "US",
      "locality": "New York",
      "postal_code": "10003"
    },
    "created_at": "2016-03-23T20:21:54.859Z",
    "creation_source": "THIRD_PARTY",
    "email_address": "New.Amelia.Earhart@example.com",
    "family_name": "Earhart",
    "given_name": "Amelia",
    "id": "JDKYHBWT1D4F8MFH63DBMEN8Y4",
    "note": "updated customer note",
    "preferences": {
      "email_unsubscribed": false
    },
    "reference_id": "YOUR_REFERENCE_ID",
    "updated_at": "2016-05-15T20:21:55Z",
    "version": 3
  }
}