MergeRequest Class


Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

Contains the data that’s needed to merge the information from two entity records of the same type.

For the Web API use the Merge Action.

Namespace:   Microsoft.Crm.Sdk.Messages
Assembly:  Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy



[DataContractAttribute(Namespace = "")]
public sealed class MergeRequest : OrganizationRequest
<DataContractAttribute(Namespace := "")>
Public NotInheritable Class MergeRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod MergeRequest()

Initializes a new instance of the MergeRequest class.


Name Description
System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty PerformParentingChecks

Gets or sets a value that indicates whether to check if the parent information is different for the two entity records. Required.

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty SubordinateId

Gets or sets the ID of the entity record from which to merge data. Required.

System_CAPS_pubproperty Target

Gets or sets the target of the merge operation. Required.

System_CAPS_pubproperty UpdateContent

Gets or sets additional entity attributes to be set during the merge operation for accounts, contacts, or leads. This property is not applied when merging incidents. Optional.


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)


Message Availability

For this message to work, the caller must be connected to the server.


Pass an instance of this class to the Execute method, which returns an instance of the MergeResponse class.

Privileges and Access Rights

To perform this action, the caller must have privileges and access rights on the specified entity in the SubordinateId property and privileges on the entity that is referred to in the Target property.

For a complete list of the required privileges, see Merge message privileges.

Supported Entities

The following table shows the default entities that support this message. For the listed entities, the caller must be connected to the server for this message to be available.






For a description of how actions on a parent record affect child records, see Entity relationship behavior.

Merge incidents

The behavior of merge for incidents is different from merging accounts, contacts, or leads in the following ways:

  • The UpdateContent property is not used.

    For other entities this property may be used to transfer selected values from the subordinate record to the target record. When merging incidents the value of this property is ignored.

  • Merge is performed in the security context of the user.

    Merge operations for other entities are performed with a system user security context. Because incident merge operations are performed in the security context of the user, the user must have the security privileges to perform any of the actions, such as re-parenting related records, that are performed by the merge operation.

    If the user merging records doesn’t have privileges for all the actions contained within the merge operation, the merge operation will fail and roll back to the original state.


The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

         // Create the target for the request.
EntityReference target = new EntityReference();

// Id is the GUID of the account that is being merged into.
         // LogicalName is the type of the entity being merged to, as a string
target.Id = _account1Id;
         target.LogicalName = Account.EntityLogicalName;

         // Create the request.
         MergeRequest merge = new MergeRequest();
         // SubordinateId is the GUID of the account merging.
         merge.SubordinateId = _account2Id;
         merge.Target = target;
         merge.PerformParentingChecks = false;

         Console.WriteLine("\nMerging account2 into account1 and adding " +
             "\"test\" as Address 1 Line 1");

         // Create another account to hold new data to merge into the entity.
         // If you use the subordinate account object, its data will be merged.
         Account updateContent = new Account();
         updateContent.Address1_Line1 = "test";

         // Set the content you want updated on the merged account
         merge.UpdateContent = updateContent;

         // Execute the request.
         MergeResponse merged = (MergeResponse)_serviceProxy.Execute(merge);

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Crm.Sdk.Messages Namespace
Merge message privileges
Sample: Merge two records
Customer entities (account, contact)
Lead entity messages and methods
How role-based security can be used to control access to entities in Microsoft Dynamics 365
How record-based security can be used to control access to records in Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright