Sign in

v1

latestOpenAPI 3.1.12026-07-268973189.3 KB
Objects

Update a company

Updates an existing company. Only provided fields will be updated. When tags is provided, it replaces the full set. Custom field values use cf_* keys — see the Custom fields guide.

patch/companies/{id}

Path parameters

idstring required

Company ID

Request body

namestring

Company name

emailstring email nullable

Email address

phonestring

Phone number with country code

taxNumberstring

Tax number

websitestring uri nullable

Website URL

descriptionstring

Description

linkedinstring uri nullable

LinkedIn URL

currencystring nullable

3-letter ISO currency code

openingBalancenumber

Opening balance

showJobAmountToWorkerboolean

Whether job amounts are visible to field workers

isClientPortalEnabledboolean

Whether the client portal is enabled

internalNotesstring

Internal notes

stageIdstring

Client stage ID

ownerUserIdstring

Owner user ID

vendorIdstring

Vendor ID

sourceIdstring

CRM source ID

tagsstring[]

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

primaryContactobject

Optional primary contact fields to create or update

Response

OK

idstring required

Company ID

namestring required

Company name

numberstring required

Auto-generated company number

type'contact' | 'company' nullable

Record type (always company for this endpoint)

emailstring nullable

Email address

phonestring nullable

Phone number

taxNumberstring nullable

Tax number

websitestring nullable

Website URL

descriptionstring nullable

Description

stageIdstring nullable

Client stage ID

stageNamestring nullable

Client stage label

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

linkedinstring nullable

LinkedIn URL

createdAtstring date-time

When the company was created

updatedAtstring date-time

When the company was last updated