Skip to content

Trigger Auto Merge

POST
/duplicates/auto-merge

Run auto-merge once. RECORDS ARE DESTROYED.

Each merge removes one record and moves its data onto the survivor. The only way back is POST /duplicates/undo-merge/{merge_history_id}, one merge at a time. Send dry_run=true first.

A 200 does NOT by itself mean anything merged: if the org has auto-merge disabled or is in shadow mode the response says so instead of failing, which is the app’s behaviour and is preserved here. Read the body.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Run auto-merge once. NOT REVERSIBLE unless you undo each merge.

Honours the org’s own auto-merge and shadow-mode settings: with either disabled the response SAYS SO instead of failing, so a 200 does not by itself mean records were merged. Send dry_run=true first.

object
dry_run

Report what would merge without merging it.

boolean
entity_type
required

Object to merge.

string
Allowed values: contact company

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