Lead entity messages and methods
Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, 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 top-level folder of the SDK download.
The following table describes the messages for this entity, which you use with the IOrganizationService.Execute method.
Message |
Description |
|---|---|
Assigns a lead to another user or team. |
|
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. |
|
Creates a lead. You can also call the IOrganizationService.Create method. |
|
Deletes a lead. You can also call the IOrganizationService.Delete method. |
|
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. |
|
Shares a lead with another security principal (user or team). |
|
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. |
|
Merges two leads. |
|
Changes the access rights for a lead previously shared with another security principal (user or team). |
|
Qualifies a lead and creates an account, contact, or opportunity records that are linked to the originating lead. |
|
Deprecated. Use the DisassociateRequest or Disassociate class. Removes the link between a lead and an account or contact. |
|
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. |
|
Retrieves a lead. You can also call the IOrganizationService.Retrieve method. |
|
Retrieves a collection of leads. You can also call the IOrganizationService.RetrieveMultiple method. |
|
Retrieves the access rights the specified security principal (user or team) has to a lead. |
|
Retrieves the security principals (users or teams) that have access to a lead, and also retrieves their access rights to the lead. |
|
Removes all access rights to a lead for the specified security principal (user or team). |
|
Deprecated. Use the AssociateRequest or Associate class. Creates a link between a lead and an account or contact. |
|
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. |
|
Updates a lead. You can also call the IOrganizationService.Update method. |
See Also
Sales entities (lead, opportunity, competitor, quote, order, invoice)
Privileges by entity
Lead entity
Sample: Qualify a lead
Microsoft Dynamics 365
© 2016 Microsoft. All rights reserved. Copyright