API ReferenceClients

Update Client

Update an existing client. Supports partial updates. Updatable fields: - Standard fields (value, size, type, etc.) - Contact information (primaryEmail, primaryPhone) - Custom fields (through custom object) Note: Updates are atomic - either all fields update or none do.

Authentication

x-api-keystring
API Key authentication via header

Path parameters

clientIdstringRequired
Client identifier

Query parameters

allow_new_optionsbooleanOptionalDefaults to false
Whether to allow creation of new dropdown options during record creation

Request

This endpoint expects an object.
addressstringOptional

Record location/address

clientTypeenum or nullOptional

Type of client (residential or commercial)

Allowed values:
companyIdintegerOptional
Company identifier
contactslist of objectsOptional
createdAtstringOptionalformat: "date-time"
Creation timestamp
custommap from strings to anyOptional
Custom fields
descriptionstring or nullOptional
Record description
idintegerOptional
Unique identifier
isActivebooleanOptional
Whether the record is active
numberintegerOptional

Record number (e.g., 1234)

primaryEmailstring or nullOptionalformat: "email"
Primary contact email
primaryPhonestring or nullOptional
Primary contact phone
titlestringOptional

Record title/name

updatedAtstringOptionalformat: "date-time"
Last update timestamp

Response

Client updated successfully
addressstring or null

Record location/address

clientTypeenum or null

Type of client (residential or commercial)

Allowed values:
companyIdinteger or null
Company identifier
contactslist of objects or null
createdAtstring or nullformat: "date-time"
Creation timestamp
custommap from strings to any or null
Custom fields
descriptionstring or null
Record description
idinteger or null
Unique identifier
isActiveboolean or null
Whether the record is active
numberinteger or null

Record number (e.g., 1234)

primaryEmailstring or nullformat: "email"
Primary contact email
primaryPhonestring or null
Primary contact phone
titlestring or null

Record title/name

updatedAtstring or nullformat: "date-time"
Last update timestamp

Errors