Customer

Update a customer by ID

Updates an existing customer record.

patch/v1/customer/{id}

Request

  • Base URL: https://api.finalpos.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.finalpos.com/v1/customer/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Customer ID

Request body

emailstring

Email address of the Customer.

firstNamestring

First name of the Customer.

lastNamestring

Last name of the Customer.

outletIdstring

Outlet ID associated with the Customer.

externalIdstring

External ID associated with the Customer when synced from external source. If present, it will set fromFinal to true.

sourcestring

Source of the customer.

phonestring

Phone number of the Customer.

totalSpentnumber

Total amount spent by the Customer.

lastActionstring

Timestamp when the Customer was last actioned.

tagsstring[]

Tags associated with the Customer.

Example request

{
  "email": "customer@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "externalId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "source": "woo-commerce",
  "phone": "+1234567890",
  "totalSpent": 100050,
  "lastAction": "2025-12-07T19:31:48.436+00:00",
  "tags": [
    "vip",
    "loyal",
    "premium"
  ],
  "metadata": [
    {
      "key": "key1",
      "value": "value1"
    },
    {
      "key": "key2",
      "value": "value2"
    }
  ],
  "notes": [
    {
      "message": "Note 1"
    }
  ]
}

Response

The customer has been successfully updated.

idstring

Unique identifier for the Customer.

createdAtstring date-time

Timestamp when the Customer was created.

updatedAtstring date-time

Timestamp when the Customer was last updated.

companyIdstring

Company ID associated with the Customer.

emailstring

Email address of the Customer.

firstNamestring

First name of the Customer.

lastNamestring

Last name of the Customer.

outletIdstring

Outlet ID associated with the Customer.

externalIdstring

External ID associated with the Customer when synced from external source. If present, it will set fromFinal to true.

sourcestring

Source of the customer.

phonestring

Phone number of the Customer.

totalSpentnumber

Total amount spent by the Customer.

lastActionstring date-time

Timestamp when the Customer was last actioned.

tagsstring[]

Tags associated with the Customer.

Example response

{
  "id": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "createdAt": "2025-12-07T19:31:48.436+00:00",
  "updatedAt": "2025-12-07T19:35:48.436+00:00",
  "companyId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "email": "customer@example.com",
  "firstName": "John",
  "lastName": "Doe",
  "outletId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "externalId": "o1p2q3r4s5t6u7v8w9x0y1z2",
  "source": "woo-commerce",
  "phone": "+1234567890",
  "totalSpent": 100050,
  "lastAction": "2025-12-07T19:31:48.436+00:00",
  "tags": [
    "vip",
    "loyal",
    "premium"
  ],
  "metadata": [
    {
      "key": "key1",
      "value": "value1"
    },
    {
      "key": "key2",
      "value": "value2"
    }
  ],
  "notes": [
    {
      "message": "Note 1"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.