API ReferenceClients

Create Client

Create a new client with required and optional fields. Required fields: - `title`: Client name - `address`: Client location Optional fields: - `clientType`: Client type (RESIDENTIAL/COMMERCIAL) - `value`: Client value - `size`: Client size - `primaryEmail`/`primaryPhone`: Contact information - `custom`: Custom fields object Note: If primaryEmail or primaryPhone is provided, a contact will be automatically created or matched.

Authentication

x-api-keystring
API Key authentication via header

Query parameters

allow_new_optionsbooleanOptionalDefaults to false
Whether to allow creation of new dropdown options during record creation
match_byenumOptionalDefaults to title
Field to use for matching existing records
Allowed values:
match_found_strategyenumOptionalDefaults to skip
Strategy to use when a match is found
Allowed values:

Request

This endpoint expects an object.
titlestringRequired
Client name
addressstringRequired

Client location/address

descriptionstring or nullOptional
Client description
clientTypeenumOptional
Client type
Allowed values:
primaryEmailstringOptionalformat: "email"
Primary contact email
primaryPhonestringOptional
Primary contact phone
custommap from strings to anyOptional
Custom fields

Response

Matching client found
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