Initiate Record 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 and moves those over to the main record. Field values on themain record are not changed, and when the process is complete, the duplicate record is deleted. Record merges do not trigger record triggers.

You can only merge two records together in a single operation, one main record and one duplicate record. This is called a merge set. If you have multiple duplicate records you wish to merge into the samemain record, 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 maximum number of concurrent merge requests is 500.

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

In Clinical Operations Vaults, this endpoint does not support merging Person (person__sys), Organization (organization__v), Location (location__v), or Contact Information (contact_information__clin) records. Instead, use Initiate Clinical Record Merge.

POST/api/{version}/vobjects/{object_name}/actions/merge

Headers

Name	Description
`Content-Type`	`application/json` or `text/csv`
`Accept`	`application/json` (default)

URI Path Parameters

Name	Description
`{object_name}`	The object `name__v` field value. For example, `account__v`. This object must have Enable Merges configured.

Body Parameters

Upload parameters as a JSON or CSV file. You can merge up to 10 merge sets at once.

Name	Description
`duplicate_record_id` required	The ID of the `duplicate` record. Each `duplicate_record_id` can only be merged into one `main_record_id` record. When the merging process is complete, Vault deletes this record.
`main_record_id` required	The ID of the `main` record. The merging process updates all inbound references (including attachments) from other objects that point to the `duplicate` record and moves those over to the `main` record. Vault does not change field values on the `main` record.

Request

curl -X POST -H "Authorization: {SESSION_ID}" \
--data-binary @"records-to-merge.json" \
https://myvault.veevavault.com/api/v25.1/vobjects/account__v/actions/merge

Example JSON Request Body

[
   {
       "duplicate_record_id" : "0V0000000000003",
       "main_record_id" : "0V0000000000013"
   },
   {
       "duplicate_record_id" : "0V0000000000004",
       "main_record_id" : "0V0000000000013"
   },
   {
       "duplicate_record_id" : "0V0000000000005",
       "main_record_id" : "0V0000000000010"
   }
]

Response

{
   "responseStatus": "SUCCESS",
   "data": {
       "job_id": 863204
   }
}

Response Details

On SUCCESS, the job has successfully started and the response includes a job_id. On FAILURE, the job failed to start. There is no partial success.