Skip to content

Merge Deal

POST
/deals/{deal_id}/merge

Merge secondary_id into this deal. NOT REVERSIBLE.

The secondary deal stops existing; its contacts, notes and activity move onto the survivor. field_overrides is the only way to keep a value from the deal being merged away.

Preview it first. There is no unmerge.

Authorizations

Parameters

Path Parameters

deal_id
required

The deal that SURVIVES.

string

The deal that SURVIVES.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Merge one deal into another. THE SECONDARY DEAL STOPS EXISTING.

secondary_id is the deal merged AWAY; the deal in the path survives. Preview it first with GET /deals/{deal_id}/merge/preview - that call says exactly which field values change and which records move.

object
field_overrides

Decide individual fields yourself instead of taking the app’s rules.

Array<object>

Which side of the merge wins one field.

Without an override the app picks per its own rules. Name a field here to decide it yourself - the only way to keep a value from the deal that is being merged AWAY.

object
field
required
string
winner
required
string
Allowed values: primary secondary
secondary_id
required

The deal to merge AWAY. Must be a UUID; the path deal survives.

string
suggestion_id
Any of:
string
trigger

What prompted the merge. Recorded on the audit row.

string
default: manual
Allowed values: manual queue bulk_criterion

Responses

200

Successful Response

object
data
required

An open envelope for a deal, a merge preview or a column result.

Open because the crossfire and merge-preview payloads are computed shapes that grow with the product, and a closed model would drop a field from an ADVISORY read - where a missing signal reads as “nothing to worry about” 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
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer

422

Validation Error

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