Initiate Record Merge

POST https://{{vaultDNS}}/api/{{version}}/vobjects/:{object_name}/actions/merge

Initiate a record merge operation in bulk. Starts a record merge job.

When merging two records together, you must select one record to be the main_record_id and one record to be the duplicate_record_id. The merging process updates all inbound references (including attachments) from other objects that point to the duplicate_record_id and moves those over to the main_record_id. Field values on themain_record_id are not changed, and when the process is complete, Vault deletes the duplicate_record_id. Record merges do not trigger record triggers.

You can only merge two records together in a single operation, one main_record_id and one duplicate_record_id. This is called a merge set.

If you have multiple duplicate_record_ids you wish to merge into the samemain_record_id, you need to create multiple merge sets and execute multiple record merges.

  • The values in the input must be UTF-8 encoded.

  • CSVs must follow the standard RFC 4180 format, with some exceptions.

  • The maximum batch size is 10 merge sets.

The object must have Enable Merges configured, and the initiating user must have the correct permissions such as the Application: Object: Merge Records permission. Learn more about the configuration required for record merges in Vault Help.

Request Body

{"0"=>{"duplicate_record_id"=>"0V0000000003", "main_record_id"=>"0V0000000013"}, "1"=>{"duplicate_record_id"=>"0V0000000004", "main_record_id"=>"0V0000000013"}, "2"=>{"duplicate_record_id"=>"0V0000000005", "main_record_id"=>"0V0000000010"}}

HEADERS

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring
Acceptstring