Skip to content

Merge Company

POST
/companies/{company_id}/merge

Merge secondary_id INTO this company. THE SECONDARY STOPS EXISTING.

Its contacts, deals and activity move onto the survivor. Undo is one merge at a time through POST /duplicates/undo-merge/{merge_history_id}. Preview first. 409 when a blocker refuses the merge.

Authorizations

Parameters

Path Parameters

company_id
required

The company that SURVIVES the merge.

integer

The company that SURVIVES the merge.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Merge secondary_id INTO the record in the path. The secondary stops existing.

Mirrors _MergeContactRequest / _MergeCompanyRequest, which are identical.

object
bulk_criterion
Any of:
string
field_overrides

Decide individual fields instead of the app’s rules.

Array<object>

Which side of a merge wins one field.

object
field
required

Field name, e.g. CONTACT_JOB_TITLE.

string
winner
required

Which record’s value to keep.

string
Allowed values: primary secondary
secondary_id
required

The record merged AWAY.

integer
suggestion_id
Any of:
string
trigger

What prompted the merge. Recorded on the audit row.

string
default: manual
Allowed values: manual bulk_criterion

Responses

200

Successful Response

object
data
required

An open envelope for one record, one dashboard or one job receipt.

Open because most of these reads are COMPUTED shapes - an engagement summary, a next-best-step, an intelligence status - that grow with the product, and dropping a field from an advisory read makes it say “nothing to report” rather than “we did not tell you”.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string