Sign in
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"
}

Changes

Changed in 1 of the 2 revisions of this API.3

  • 0e449a4e0dc83See the full diff
    • ○

      added the new optional request property createdAt

      new-optional-request-property

    • ○

      added the new optional request property netPaymentTerms

      new-optional-request-property

    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added