Lead

Represents a prospect or potential Opportunity.

Fields

Field	Field Type	Field Properties	Description
AnnualRevenue	currency	Create Filter Nillable Update	Annual revenue for the company of the lead.
City	string	Create Filter Nillable Update	City for the address of the lead.
Company	string	Create Filter Nillable Update	Required. Company of the lead. Note In organizations where person account record types have been enabled, if the value of the Company field is null, the lead converts to a person account. See "Notes on Converting Leads" in the Salesforce online help for more information.
ConnectionReceivedID	reference	Filter Nillable	ID of the PartnerNetworkConnection that shared this record with your organization. This field is only available if you have enabled Salesforce to Salesforce.
ConnectionSentID	reference	Filter Nillable	ID of the PartnerNetworkConnection that you shared this record with. This field is only available if you have enabled Salesforce to Salesforce.
ConvertedAccountId	reference	Filter Nillable	Object reference ID that points to the Account into which the Lead has been converted. For information on IDs, see ID Field Type.
ConvertedContactId	reference	Filter Nillable	Object reference ID that points to the Contact into which the Lead has been converted.
ConvertedDate	date	Filter Nillable	Date on which this Lead was converted.
ConvertedOpportunityId	reference	Filter Nillable	Object reference ID that points to the Opportunity into which the Lead has been converted.
Country	string	Create Filter Nillable Update	Country for the address of the lead.
Description	textarea	Create Nillable Update	Description of the lead.
Email	email	Create Filter Nillable idLookup Update	Email address for the lead.
EmailBouncedDate	dateTime	Filter Nillable Update	If bounce management is activated and an email sent to the lead bounced, the date and time the bounce occurred.
EmailBouncedReason	string	Filter Nillable Update	If bounce management is activated and an email sent to the lead bounced, the reason the bounce occurred.
Fax	phone	Create Filter Nillable Update	Fax number for the lead.
FirstName	string	Create Filter Nillable Update	First name of the lead. Limited to 40 characters.
HasOptedOutOfEmail	boolean	Create Defaulted on create Filter Update	Indicates whether the lead has opted out of email (true) or not (false). Label is Email Opt Out.
Industry	picklist	Create Filter Nillable Update	Industry the lead works in.
IsConverted	boolean	Create Defaulted on create Filter	Indicates whether the Lead has been converted (true) or not (false). Label is Converted.
IsDeleted	boolean	Defaulted on create Filter	Indicates whether the object has been moved to the Recycle Bin (true) or not (false). Label is Deleted.
IsUnreadByOwner	boolean	Create Defaulted on create Filter Update	If true, lead has been assigned, but not yet viewed. See Unread Leads for more information. Label is Unread By Owner.
LastActivityDate	date	Filter Nillable	Value is one of the following, whichever is the most recent: Due date of the most recent event logged against the record. Due date of the most recently closed task associated with the record.
LastName	string	Create Filter Nillable	Required. Last name of the lead. Limited to 80 characters.
LeadSource	picklist	Create Filter Nillable Update	Source from which the lead was obtained.
masterRecordId	reference	Filter Nillable	If this object was deleted as the result of a merge, this field contains the ID of the record that was kept. If this object was deleted for any other reason, or has not been deleted, the value is null.
MobilePhone	phone	Create Filter Nillable Update	Mobile phone number for the lead.
Name	string	Filter	Concatenation of FirstName and LastName. Limited to 121 characters.
NumberOfEmployees	int	Create Filter Nillable Update	Number of employees at the lead’s company. Label is Employees.
OwnerId	reference	Create Defaulted on create Filter Update	ID of the owner of the lead.
Phone	phone	Create Filter Nillable Update	Phone number for the lead.
PostalCode	string	Create Filter Nillable Update	Postal code for the address of the lead. Label is Zip/Postal Code.
Rating	picklist	Create Filter Nillable Update	Rating of the lead.
Salutation	picklist	Create Filter Nillable Update	Salutation for the lead.
State	string	Create Filter Nillable Update	State for the address of the lead.
Status	picklist	Create Defaulted on create Filter Update	Status code for this converted lead. Status codes are defined in the lead status picklist and represented in the API by the LeadStatus object. See Lead Status Picklist for more information.
Street	textarea	Create Filter Nillable Update	Street number and name for the address of the lead.
Title	string	Create Filter Nillable Update	Title for the lead, for example CFO or CEO.
Website	url	Create Filter Nillable Update	Website for the lead.

Note

If you are importing Lead data into Salesforce and need to set the value for an audit field, such as CreatedDate, contact salesforce.com. Audit fields are automatically updated during API operations unless you request to set these fields yourself. For more information, see System Fields.

Converted Leads

Leads have a special state to indicate that they have been converted into an Account, Contact, and optionally, an Opportunity. Your client application can convert leads via the convertLead() call. Users can also convert leads through the Salesforce user interface. Once a lead has been converted, it is read-only. You cannot update() or delete() a converted lead. However, you can query converted Leads using the query() call.

Leads have several fields that indicate their converted status. These special fields are read-only via the API. You cannot set these fields directly; they are set when converting the lead in the Salesforce user interface. The fields are:

• ConvertedAccountId
• ConvertedContactId
• ConvertedDate
• ConvertedOpportunityId
• IsConverted
• Status

Note

In organizations where person account record types have been enabled, if the value of the Company field is null, the lead converts to a person account. See "Notes on Converting Leads" in the Salesforce online help for more information.

When you create(), update(), or upsert() a lead, your client application can have the lead automatically assigned to one or more Users based on assignment rules that have been configured in the Salesforce user interface.

To use this feature, your client application needs to set either of the following options (but not both) in the AssignmentRuleHeader used in the create() or update() call:

The following example shows how to automatically assign a newly created lead.

 package com.sforce; 
 import java.net.MalformedURLException; 
 import java.net.URL; 
 import java.rmi.RemoteException; 
 
 import com.sforce.soap.enterprise.LoginResult; 
 import com.sforce.soap.enterprise.QueryResult; 
 import com.sforce.soap.enterprise.SaveResult; 
 import com.sforce.soap.enterprise.SforceServiceLocator; 
 import com.sforce.soap.enterprise.SoapBindingStub; 
 import com.sforce.soap.enterprise._AssignmentRuleHeader; 
 import com.sforce.soap.enterprise._SessionHeader; 
 import com.sforce.soap.enterprise.fault.LoginFault; 
 import com.sforce.soap.enterprise.fault.UnexpectedErrorFault; 
 import com.sforce.soap.enterprise.sobject.Lead; 
 import com.sforce.soap.enterprise.sobject.SObject; 
 
 public class LeadAssignment {
 
  static LeadAssignment _leadAssignment;
   
  public static void main(String[] args) { 
  _leadAssignment = new LeadAssignment(); 
  try { 
  _leadAssignment.CreateLead(); 
  } catch (Exception e) { 
  e.printStackTrace(); 
  } 
  } 
   
  public void CreateLead() throws UnexpectedErrorFault, LoginFault, 
   RemoteException { 
  //Create the proxy binding and login 
  SoapBindingStub binding = (SoapBindingStub) new SforceServiceLocator().getSoap();
  LoginResult lr = binding.login("user@domain.net", "secret"); 
   
  //Reset the binding to use the endpoint returned from login 
   binding._setProperty(SoapBindingStub.ENDPOINT_ADDRESS_POINT, 
    loginResult.getServerUrl());
   
  //Create the session id header, and add it to the proxy binding 
  _SessionHeader sh = new _SessionHeader(); 
  sh.setSessionId(lr.getSessionId()); 
  binding.setHeader(new SforceServiceLocator().getServiceName().getNamespaceURI(), 
   "SessionHeader", sh);
   
  //Create a new case and assign various properties 
  Lead lead = new Lead(); 
   
  lead.setFirstName("Joe"); 
  lead.setLastName("Smith"); 
  lead.setCompany("ABC Corporation"); 
  lead.setLeadSource("API"); 
  //The lead assignment rule will assign any new leads that 
  //have "API" as the LeadSource to a particular user 
   
  //Create the assignment rule header and add it to the proxy binding 
  _AssignmentRuleHeader arh = new _AssignmentRuleHeader(); 
   
  //In this sample we will look for a particular rule and if found 
  //use the id for the lead assignment. If it is not found we will 
  //instruct the call to use the current default rule. You cannot use 
  //both of these values together. 
  QueryResult qr = binding.query("Select Id From AssignmentRule where Name = 
 'Mass Mail Campaign' and RuleType = 'leadAssignment'"); 
  if (qr.getSize() == 0) { 
  arh.setUseDefaultRule(new Boolean(true)); 
  } else { 
  arh.setAssignmentRuleId(qr.getRecords(0).getId()); 
  } 
   
  binding.setHeader(new
  SforceServiceLocator().getServiceName().getNamespaceURI(), "AssignmentRuleHeader", 
    arh); 
   
  // Every operation that results in a new or updated case, will 
  // use the specified rule until the header is removed from the 
  // proxy binding. 
  SaveResult[] sr = binding.create(new SObject[] {lead}); 
  for (int i=0;i<sr.length;i++) { 
  if (sr[i].isSuccess()) 
  System.out.println("Successfully creaeted lead with id of: " + 
    sr[i].getId().getValue() + "."); 
  else 
  System.out.println("Error creating lead: " + 
    sr[i].getErrors(0).getMessage()); 
  } 
   
  // This call effectively removes the header, the next lead will 
  // be assigned to the default lead owner. Remember to add the 
  // session header back in. 
  binding.clearHeaders(); 
  binding.setHeader(new
  SforceServiceLocator().getServiceName().getNamespaceURI(), "SessionHeader", sh); 
   
  } 
 }