CreateCustomerRelationshipsRequest Class


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

Contains the data that is needed to create a new customer lookup attribute, and optionally, to add it to a specified unmanaged solution.

For the Web API use the CreateCustomerRelationships Action .

Web API support for this message was added with December 2016 update for Microsoft Dynamics 365 (online) and December 2016 Service Pack for Microsoft Dynamics 365 (on-premises) .

Namespace:   Microsoft.Xrm.Sdk.Messages
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Inheritance Hierarchy



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


Name Description
System_CAPS_pubmethod CreateCustomerRelationshipsRequest()

Initializes a new instance of the CreateCustomerRelationshipsRequest 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 Lookup

Gets or sets the metadata for the lookup field used to store the ID of the related record. Required.

System_CAPS_pubproperty OneToManyRelationships

Gets or sets the metadata array for the one-to-many relationships to the Account and Contact entity. Required.

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 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 SolutionUniqueName

Gets or sets the name of the unmanaged solution to which you want to add this customer lookup attribute to. 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 CreateCustomerRelationshipsResponse class.

Privileges and Access Rights

To perform this action, the caller must have the required privileges, as listed in CreateCustomerRelationships message privileges.

Notes for Callers

Use the CreateCustomerRelationshipsRequest message to create two entity relationships to the lookup attribute: one to the Account entity and the other one to the Contact entity. You cannot add relationship to any other entity except for Account and Contact entities.

Supported Entities

You can only add attributes to customizable entities where the managed property CanCreateAttributes is true.


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.

CreateCustomerRelationshipsRequest createCustomerReq = new CreateCustomerRelationshipsRequest
    Lookup = new LookupAttributeMetadata
        Description = new Label("The owner of the bank account", 1033),
        DisplayName = new Label("Account owner", 1033),
        RequiredLevel = new AttributeRequiredLevelManagedProperty(AttributeRequiredLevel.ApplicationRequired),
        SchemaName = "new_customerid"
    OneToManyRelationships = new OneToManyRelationshipMetadata[]
        new OneToManyRelationshipMetadata()
            ReferencedEntity = "account",
            ReferencingEntity = _customEntityName,
            SchemaName = "new_bankaccount_customer_account",
        new OneToManyRelationshipMetadata()
            ReferencedEntity = "contact",
            ReferencingEntity = _customEntityName,
            SchemaName = "new_bankaccount_customer_contact",

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.Xrm.Sdk.Messages Namespace
Create a customer lookup attribute
Sample: Create and update entity metadata

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright