Skip to main content

Create a company

Create a company

Request Body REQUIRED
name string REQUIRED

The name of the company

externalUid string

External unique identifier for the company from an external system

segments string[]

Possible values: length ≤ 255

Segment names to attach the new company to. A name resolving to a dynamic segment is ignored — its membership is computed from its rule, not assigned. A name the project does not carry yet is created. Max 200 names per request.

Responses
200

Update a single company

Schema OPTIONAL
company object

The company data

id string

Unique identifier of the company

clientId string

Client identifier

name string

Name of the company

description string OPTIONAL

Description of the company

domains string[]

Domains associated with the company

createdAt date-time

Creation date of the company

updatedAt date-time

Last update date of the company

importId string OPTIONAL

Only defined when the company was created from XLSX import, equal to its defined ID

externalUid string OPTIONAL

Only defined when external uid has been setup in Harvestr and when the entity has an external uid in source

segments object[]

Segments associated with this company

id string

Unique identifier of the segment

clientId string

Client identifier

name string

Name of the segment

dynamicType string

Possible values: [MANUAL, DYNAMIC]

How the segment's membership is decided. MANUAL segments are assigned, and are the only ones this API can attach a contributor to. A DYNAMIC segment's membership is computed from its rule, so a name resolving to one is ignored on write and the segment still appears here when the contributor matches it.

createdAt date-time

Creation date of the segment

updatedAt date-time

Last update date of the segment