companiesMerge
Merge several companies into one, applying companyFields as overrides on
the surviving record.
Merging is not reversible. All source companies except the resulting record are absorbed into it.
Side effects: emits a company.merged activity event.
Auth · x-app-token · required permission companiesMerge
Related: companiesRemove, Company
companiesMerge(companyIds: [String], companyFields: JSON): CompanyArguments
Ids of the companies to merge together.
Field overrides applied to the resulting merged company, as JSON.
Returns
When this record was created.
When this record was last updated.
Logo/avatar image URL.
Approximate headcount.
Company website URL.
Industry classification (free text).
Subscription plan label for this account, if tracked.
Id of the parent Company in a hierarchy, if any.
Id of the User assigned as owner of this company.
Ids of companies previously absorbed into this one via companiesMerge.
All known names for this company.
Main display name.
All known email addresses.
Main email address, used for identity matching.
All known phone numbers.
Main phone number, used for identity matching.
Primary mailing address as free-form JSON.
All known addresses as free-form JSON.
Business type classification (free text).
Free-form notes about this company.
Subscription/marketing consent flag, e.g. "Yes" / "No".
Social/external profile links as free-form JSON.
Custom field values as an array of { field, value } entries.
Custom field values keyed by field code instead of field id.
Short human-friendly identifier. Accepted anywhere _id is accepted on lookups such as companyDetail.
Free-text location label.
Engagement/lead score, when scoring is enabled for this workspace.