v1

latestOpenAPI 3.1.12026-07-268973189.3 KB

Objects

Create contact

Creates a new contact record. The contact is assigned to the user associated with your API key. Related entity IDs use prefixed string IDs (for example clt_, cs_, usr_, tag_). Tag with tags (tag_ prefix). Custom field values use cf_* keys — see the Custom fields guide.

post/contacts

Request body

firstNamestring required

Contact first name

lastNamestring

Contact last name

salutationstring

Title (Mr., Mrs., Dr., etc.)

emailstring email nullable

Email address

phonestring

Phone number with country code

jobTitlestring

Job title or position

companyIdstring

ID of the parent company to link this contact to

stageIdstring

Client stage ID

leadStageIdstring

Lead stage ID

ownerUserIdstring

Owner user ID

vendorIdstring

Vendor ID

sourceIdstring

CRM source ID

tagsstring[]

Tag IDs (tag_ prefix). Replaces the full set when provided.

Response

idstring required

Contact person's ID (clt_ prefix)

namestring required

Display name

numberstring required

Auto-generated contact number

type'contact' | 'company' nullable

Record type (always contact for this endpoint)

firstNamestring required

First name

lastNamestring nullable

Last name

emailstring nullable

Email address

phonestring nullable

Phone number

salutationstring nullable

Salutation

jobTitlestring nullable

Job title

descriptionstring nullable

Description

taxNumberstring nullable

Tax number

websitestring nullable

Website URL

companyIdstring nullable

Parent company ID

companyNamestring nullable

Parent company name

parentClientIdstring nullable

Parent client ID (same as companyId for contacts)

stageIdstring nullable

Client stage ID

stageNamestring nullable

Client stage label

leadStageIdstring nullable

Lead stage ID

ownerUserIdstring nullable

Owner user ID

crmSourceIdstring nullable

CRM source ID

sourceNamestring nullable

CRM source name

currencystring nullable

Currency code

openingBalancenumber required

Opening balance

showJobAmountToWorkerboolean required

Whether job amounts are visible to field workers

isClientPortalEnabledboolean required

Whether the client portal is enabled

internalNotesstring nullable

Internal notes

profileImagestring nullable

Profile image URL

instagramstring nullable

Instagram handle or URL

facebookstring nullable

Facebook handle or URL

linkedinstring nullable

LinkedIn handle or URL

twitterstring nullable

Twitter handle or URL

createdAtstring date-time

When the contact was created

updatedAtstring date-time

When the contact was last updated