Link links two or more base object records using the specified groupRecordKey as the group ID. Unlike a merge operation, when records are linked, the original base object records continue to exist and the cross reference records are not directly associated with the grouping record. However, the cross reference records are grouped together in a link group with the rowid of the groupRecordKey specified in the LinkRequest. If the records specified for linking have been previously linked, then nothing is changed and the API returns a success message.

In order to be able to use the Link request on a base object, the base object must first be configured to be a link-style BO instead of a merge-style BO. This option can be configured in the Schema Manager of the Hub Console.

In order to use a link group, the GetBvt request must be invoked. This retrieves the best version of truth (BVT) for the specified link group accounting for the combined cross reference records of all base object records in the link group.