Updating Customers - Do all values need to be provided

Apologies if this is in the documentation, I wasn’t able to find it. When updating a customer, do I need to provide all the values, or just the ones I’m updating.

Simplified example - say I create a customer with:

{
     "firstName": "Jon",
     "lastName": "Doe",
     "email": "jdoe@gmail.com"
}

and I want to update the name from Jon to John. Do I need to pass in

{
     "firstName": "John",
     "lastName": "Doe",
     "email": "jdoe@gmail.com"
}

or

{
     "firstName": "John"
}

Hi @dtj, That’s a good question. It depends on the Customer type that you are attempting to update. There are 3 different types as outlined below:

Receive-only users

For this type, you can update one or many fields. If you just need to update lastName, then you could do something like:

{
     "lastName": "Doe"
}

Unverified Customer

Same as above. You can simply pass in one or many fields to the request body.

Verified Customers

The fields that can be updated depend on whether it is a business or personal verified Customer, as well as what the status of the Customer.

Personal (Individual)

For personal Verified Customers that have a verified status, all contact information can be updated. e.g. one or all of the fields in the example request body below:

{
  "email": "someemail@nomail.net",
  "ipAddress": "10.10.10.10",
  "type": "personal",
  "address1": "99-99 33rd St",
  "address2": "Unit 414"
  "city": "Some City",
  "state": "NY",
  "postalCode": "11101",
  "phone": "5554321234"
}

Business

For business Verified Customers that have a verified status, all contact information for the business can be updated. One or many of the following fields:

Business - Sole-proprietorship, Corporation, LLC, or Partnership
{
    "email": "solePropBusiness@email.com",
    "ipAddress": "143.156.7.8",
    "address1": "99-99 33rd St",
    "address2": "Unit 103"
    "city": "Some City",
    "state": "NY",
    "postalCode": "11101",
    "phone": "555-555-5555",
    "doingBusinessAs":"Jane Corp",
    "website":"https://myapp.com"
}

Note: If the business has a retry status then all fields that are acceptable in the initial Customer creation request can be updated.

Hope this helps! We’ll work to update our docs for clarity, so thanks for bringing this to our attention!

2 Likes