Sign in

v2

latestOpenAPI 3.0.0raw.githubusercontent.com2026-02-16143114179.4 KB
Customers

Update a customer

Update customer fields. Only provided fields will be changed.

patch/api/customers/{id}

Path parameters

idstring required

Customer ID

Request body

externalIdstring

Tenant's user ID

emailstring
namestring
countrystring
currencystring

ISO currency code

metadataobject

Custom metadata

netPaymentTermsnumber

Net payment terms in days (overrides org and plan defaults)

createdAtstring

Backdate createdAt (ISO 8601). For data imports.

Example request

{
  "externalId": "user_12345",
  "email": "customer@example.com",
  "name": "Jane Doe",
  "country": "NG",
  "currency": "NGN",
  "netPaymentTerms": 30
}

Response

Customer updated successfully

idstring required
externalIdstring required
emailstring required
namestring
countrystring
currencystring required
metadataobject
createdAtstring required
updatedAtstring required

Example response

{
  "id": "clx1234567890",
  "externalId": "user_12345",
  "email": "customer@example.com",
  "name": "Jane Doe",
  "country": "US",
  "currency": "USD"
}