PATCH
/
v1
/
businesses
/
{businessId}
/
customers
/
{customerId}
Patch update customer
curl --request PATCH \
  --url https://sandbox.layerfi.com/v1/businesses/{businessId}/customers/{customerId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "individual_name": "<string>",
  "company_name": "<string>",
  "email": "<string>",
  "mobile_phone": "<string>",
  "office_phone": "<string>",
  "address_string": "<string>",
  "memo": "<string>",
  "status": "ACTIVE",
  "tags": [
    {
      "key": "Location",
      "value": "MainStreet"
    }
  ]
}'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "31415926535",
  "individual_name": "<string>",
  "company_name": "<string>",
  "email": "<string>",
  "mobile_phone": "<string>",
  "office_phone": "<string>",
  "address_string": "<string>",
  "memo": "<string>",
  "status": "ACTIVE",
  "transaction_tags": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "ExampleTagKey",
      "value": "ExampleTagValue",
      "dimension_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "definition_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "deleted_at": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
businessId
string<uuid>
required

The UUID of the business the customer belongs to

​
customerId
string<uuid>
required

The UUID of the customer to update

Body

application/json

Parameters for updating a customer. All fields are optional.

​
individual_name
string | null

Full name of the individual customer or contact at a corporate customer.

​
company_name
string | null

Name of the company customer.

​
email
string | null

Email address of the customer.

​
mobile_phone
string | null

Mobile phone number of the customer.

​
office_phone
string | null

Office phone number of the customer.

​
address_string
string | null

Address of the customer.

​
memo
string | null

Memo for any text you would like to associate with the customer (for example, to display to end users).

​
status
enum<string>

Status of the customer. Possible values: ACTIVE, ARCHIVED.

Available options:
ACTIVE,
ARCHIVED
​
tags
object[]

Response

200 - application/json

Customer updated successfully

​
id
string<uuid>

Unique identifier for the customer.

​
external_id
string

Unique ID of the customer in your system for linking purposes. Idempotency key.

Example:

"31415926535"

​
individual_name
string | null

Full name of the individual customer or contact at a corporate customer.

​
company_name
string | null

Name of the company customer.

​
email
string | null

Email address of the customer.

​
mobile_phone
string | null

Mobile phone number of the customer.

​
office_phone
string | null

Office phone number of the customer.

​
address_string
string | null

Address of the customer.

​
memo
string | null

Memo for any text you would like to associate with the customer (for example, to display to end users).

​
status
string

Status of the customer. Possible values: ACTIVE, ARCHIVED.

Example:

"ACTIVE"

​
transaction_tags
object[]