Skip to content

Preview Deal Merge

GET
/deals/{deal_id}/merge/preview

What the merge WOULD do. Changes nothing.

Worth calling first for the same reason the app does: merging is not reversible, and this is the only place that says which field values change and which records move before they do.

Authorizations

Parameters

Path Parameters

deal_id
required

The deal that SURVIVES.

string

The deal that SURVIVES.

Query Parameters

secondary
required

The deal that would be merged AWAY.

string

The deal that would be merged AWAY.

Header Parameters

X-Target-Org-Id
Any of:
string

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