QualifyLeadRequest.ProcessInstanceId Property

Definition

Gets or sets the ID of a business process flow instance running for the Lead record that should be set for the Opportunity record (created on qualifying the Lead record). Optional.

public:
 property Microsoft::Xrm::Sdk::EntityReference ^ ProcessInstanceId { Microsoft::Xrm::Sdk::EntityReference ^ get(); void set(Microsoft::Xrm::Sdk::EntityReference ^ value); };
public Microsoft.Xrm.Sdk.EntityReference ProcessInstanceId { get; set; }
member this.ProcessInstanceId : Microsoft.Xrm.Sdk.EntityReference with get, set
Public Property ProcessInstanceId As EntityReference

Property Value

The ID of a business process flow instance running for the Lead record.

Remarks

An entity record can have multiple business process flow instances running at the same time. When you have multiple business process flow instances for a Lead record, you can use this property to specify the business process flow instance that you want to set for the Opportunity record, which will be created on qualifying the lead record. If you do not specify a value for this property while qualifying a lead, by default, the business process flow instance that is currently active on the UI for the Lead record is set as the active record for the Opportunity record.

Applies to