Export (0) Print
Expand All

Lead entity messages and methods

Applies To: Microsoft Dynamics CRM 2013, Microsoft Dynamics CRM Online

A lead is used to track contacts or accounts that are potential customers but who have not yet been qualified. The schema name for this entity is Lead. To view the entity metadata for your organization, install the Metadata Browser solution described in Browse the metadata for your organization. You can also view the metadata for an uncustomized organization in the Excel file called EntityMetadata.xlsx included in the tools folder of the SDK download.

The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.

 

Message Description

AssignRequest

Assigns a lead to another user or team.

AssociateRequest

Creates a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Associate method. For more information, see Actions on Entity Records. For a list of default relationships for this entity, refer to the lead entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

CreateRequest

Creates a lead. You can also call the IOrganizationService.Create method.

DeleteRequest

Deletes a lead. You can also call the IOrganizationService.Delete method.

DisassociateRequest

Removes a link between a record and one or more records that participate in a relationship. You can also use the IOrganizationService.Disassociate method. For more information, see Actions on Entity Records. For a list of default relationships for this entity, refer to the lead entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

GrantAccessRequest

Shares a lead with another security principal (user or team).

InitializeFromRequest

Initializes a new record from an existing record provided that an attribute map is defined for the two entities. For more information, see Customize entity and attribute mappings.

MergeRequest

Merges two leads.

ModifyAccessRequest

Changes the access rights for a lead previously shared with another security principal (user or team).

QualifyLeadRequest

Qualifies a lead and creates an account, contact, or opportunity records that are linked to the originating lead.

RemoveRelatedRequest

Deprecated. Use the DisassociateRequest or Disassociate class. Removes the link between a lead and an account or contact.

RetrieveDuplicatesRequest

Detects and retrieves duplicate records for the specified record provided that duplicate detection is enabled and there are published duplicate detection rules for the entity. For more information, see Detect duplicate data.

RetrieveRequest

Retrieves a lead. You can also call the IOrganizationService.Retrieve method.

RetrieveMultipleRequest

Retrieves a collection of leads. You can also call the IOrganizationService.RetrieveMultiple method.

RetrievePrincipalAccessRequest

Retrieves the access rights the specified security principal (user or team) has to a lead.

RetrieveSharedPrincipalsAndAccessRequest

Retrieves the security principals (users or teams) that have access to a lead, and also retrieves their access rights to the lead.

RevokeAccessRequest

Removes all access rights to a lead for the specified security principal (user or team).

SetRelatedRequest

Deprecated. Use the AssociateRequest or Associate class. Creates a link between a lead and an account or contact.

SetStateRequest

Sets the state of a lead. If you are using early bound types, use the LeadState enumeration to set the possible states. For a list of the state values, refer to the LeadState entity metadata. You can find this information in the metadata for your organization. See the preceding metadata browser information.

UpdateRequest

Updates a lead. You can also call the IOrganizationService.Update method.

See Also

Microsoft Dynamics CRM 2013 and Microsoft Dynamics CRM Online
Send comments about this topic to Microsoft.
© 2014 Microsoft Corporation. All rights reserved.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft