Objects

Create company

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

post/companies

Request

  • Base URL: https://api.heffl.com/api/v2
  • URL: https://api.heffl.com/api/v2/companies
  • Auth: API key in header x-api-key

Request body

namestring required

Company name

emailstring email nullable

Email address

phonestring

Phone number with country code

taxNumberstring

Tax number

websitestring uri

Website URL

descriptionstring

Description

linkedinstring uri

LinkedIn URL

currencystring

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 to create with the company

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

Changes

No recorded changes to this operation across all 1 revision of this API.