PUT
/
v1
/
businesses
/
{business_id}
/
customers
/
{customer_id}
curl -X PUT https://sandbox.layerfi.com/v1/businesses/${business_id}/customers/${customer_id} \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
    -d '{
          "external_id": "customer-1",
          "individual_name": "John Doe",
          "company_name": "Acme, Inc.",
          "email": "john@hotmail.com",
          "mobile_phone": "555-555-5555",
          "office_phone": "555-555-5555",
          "address_string": "123 Main St, Phoenix, AZ 85001",
          "notes": "This is a note"
        }'

{
 "data": {
   "type": "CustomerData",
   "id": "4f7c1b16-e057-4ec0-8b20-50308ba5b9ea",
   "external_id": "customer-1",
   "individual_name": "John Doe",
   "company_name": "Acme, Inc.",
   "email": "john@hotmail.com",
   "mobile_phone": "555-555-5555",
   "office_phone": "555-555-5555",
   "address_string": "123 Main St, Phoenix, AZ 85001",
   "notes": "This is a note",
   "status": "ACTIVE"
 }
}

The PUT endpoint updates an existing customer.

​
Path Parameters

​
business_id
string
required

ID of the Business the customer is associated with.

​
customer_id
string
required

ID of the Customer to be updated.

​
Body

​
external_id
string

External ID for the customer within your platform. Idempotency key.

​
individual_name
string

Name of the individual customer.

​
company_name
string

Name of the company customer.

​
email
string

Email address of the customer.

​
mobile_phone
string

Mobile phone number of the customer.

​
office_phone
string

Office phone number of the customer.

​
address_string
string

Full address of the customer.

​
notes
string

Notes about the customer.

​
Response

Returns the udpated Customer object

curl -X PUT https://sandbox.layerfi.com/v1/businesses/${business_id}/customers/${customer_id} \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
    -d '{
          "external_id": "customer-1",
          "individual_name": "John Doe",
          "company_name": "Acme, Inc.",
          "email": "john@hotmail.com",
          "mobile_phone": "555-555-5555",
          "office_phone": "555-555-5555",
          "address_string": "123 Main St, Phoenix, AZ 85001",
          "notes": "This is a note"
        }'

{
 "data": {
   "type": "CustomerData",
   "id": "4f7c1b16-e057-4ec0-8b20-50308ba5b9ea",
   "external_id": "customer-1",
   "individual_name": "John Doe",
   "company_name": "Acme, Inc.",
   "email": "john@hotmail.com",
   "mobile_phone": "555-555-5555",
   "office_phone": "555-555-5555",
   "address_string": "123 Main St, Phoenix, AZ 85001",
   "notes": "This is a note",
   "status": "ACTIVE"
 }
}
Create a customerArchive a customer