Update a company

Update a company

Path Parameters
id string — REQUIRED Unique identifier (id or clientId)

Request Body — REQUIRED
name string The name of the company
externalUid string External unique identifier for the company from an external system. Set to null to remove
segments string[] Possible values: length ≤ 255 Segment names the company belongs to. Omit the field to leave segments untouched, send an empty array to clear them, or send a list to replace them. Only manual segments are affected: a dynamic segment's membership is computed from its rule, so it survives whatever this list contains. A name resolving to a dynamic segment is ignored — the rest of the list is applied and the request still succeeds. 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