Skip to content
Home/
REST API Reference
/
/
Merge preview request

Merge preview request

Preview a contact merge.

fromstringrequired

The unique identifier for the contact to merge away from (the source contact). Can have a role of lead or user.

Example:"6762f0d51bb69f9f2193bb7f"
intostringrequired

The unique identifier for the contact to merge into (the destination contact). Must have a role of user.

Example:"6762f0d51bb69f9f2193bb80"
skip_duplicate_validationboolean

When true, previews the merge even if the contacts don't share a common identifier. Must be a JSON boolean; the string "true" does not bypass the check. Defaults to false.

Default:false
custom_attribute_namesArray of strings

Custom attribute names to include in the previewed attribute changes.

{
  "from": "6762f0d51bb69f9f2193bb7f",
  "into": "6762f0d51bb69f9f2193bb80",
  "skip_duplicate_validation": false,
  "custom_attribute_names": [
    "string"
  ]
}