RemoveRelated Message

banner art

Removes the relationship between two entity instances as defined by the target classes listed below. For example, remove the relationship between an invoice and a contact.

The relevant classes are specified in the following table.

Type Class
Request RemoveRelatedRequest
Response RemoveRelatedResponse
Target TargetRelated
Entity See below.

The following table shows the entities and target classes for this message.

Entity Target Class
invoice TargetRelatedInvoiceToContact
lead TargetRelatedLeadToAccount

TargetRelatedLeadToContact

opportunity TargetRelatedOpportunityToAccount

TargetRelatedOpportunityToCompetitor

TargetRelatedOpportunityToContact

product TargetRelatedProductToCompetitor

TargetRelatedProductToLead

quote TargetRelatedQuoteToContact
salesliterature TargetRelatedSalesLiteratureToCompetitor

TargetRelatedSalesLiteratureToProduct

salesorder TargetRelatedSalesOrderToContact

Remarks

To perform this action, the caller must have access rights on the entity instance specified in the request class. For a list of required privileges, see RemoveRelated Privileges.

The RemoveRelated and SetRelated messages support all types of relationships, including one-to-many and many-to-many. SetRelated and RemoveRelated can be used with custom entities.

Example

The following code example shows how to use the RemoveRelated message.

[C#]
// Set up the CRM Service.
CrmService service = new CrmService();
service.Credentials = System.Net.CredentialCache.DefaultCredentials;

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

// AccountId is the GUID of the account to be related to the lead.
target.AccountId = new Guid("D3652E9C-D328-4CA1-B284-1215C441AD94");

// LeadId is the GUID of the lead to be related to the account.
target.LeadId = new Guid("9DAEE309-A3D6-470C-80E2-DDC657BAFC16");

// Create the request object.
RemoveRelatedRequest remove = new RemoveRelatedRequest();

// Set the properties of the request object.
remove.Target = target;

// Execute the request.
RemoveRelatedResponse related = (RemoveRelatedResponse)service.Execute(remove);

[Visual Basic .NET]
' Set up the CRM Service.
Dim service As New CrmService()
service.Credentials = System.Net.CredentialCache.DefaultCredentials

' Create the target object for the request.
Dim target As New TargetRelatedLeadToAccount()

' AccountId is the GUID of the account to be related to the lead.
target.AccountId = new Guid("D3652E9C-D328-4CA1-B284-1215C441AD94");

' LeadId is the GUID of the lead to be related to the account.
target.LeadId = new Guid("9DAEE309-A3D6-470C-80E2-DDC657BAFC16");

' Create the request object.
Dim remove As New RemoveRelatedRequest()

' Set the properties of the request object.
remove.Target = target

' Execute the request.
Dim related As RemoveRelatedResponse = CType(service.Execute(remove), RemoveRelatedResponse)

Related Topics

CrmService Messages

© 2007 Microsoft Corporation. All rights reserved.