Leads
Captures unqualified prospects with details such as source and rating, and supports conversion into contacts, accounts, or deals.
Table-Specific Information
Select
This table supports the COQL and BULK APIs for filtering, meaning that most filters comparing columns to values are submitted server-side.
Note: When ReadAPI is set to COQL, a SELECT * query may fail due to the large number of columns in this table. To avoid this error:
- Specify fewer than 50 columns in the SELECT clause
- Or set the ReadAPI connection property to REST or BULK to use the REST or BULK API instead
Insert
You must specify the LastName column when inserting a new lead. The following examples demonstrate valid insert operations:
-- Insert a lead with a first name, last name, and title
INSERT INTO Leads (FirstName, LastName, Title) VALUES ('Alert', 'Bat', 'Mr')
-- Insert a lead and trigger associated workflows, approvals, or blueprints
INSERT INTO Leads (FirstName, LastName, Email, Trigger) VALUES ('Enthusiastic', 'Panda', '[email protected]', 'workflow,approval,blueprint')
Required fields: LastName is required.
Any field which is not read-only (ReadOnly = false in the table schema) can be inserted.
Delete
You must specify the Id column in the WHERE clause to delete a record. The following example demonstrates a delete operation:
-- Delete a lead by its unique ID
DELETE FROM Leads WHERE Id = '3152079000000153079'
Update
You must specify the Id column in the WHERE clause to update a record. The following example demonstrates an update operation:
-- Update the description field for a specific lead
UPDATE Leads SET Description = 'Changed from the API.' WHERE Id = '3152079000000488014'
Required fields: Id is required. The update must target a specific record.
Any field which is not read-only (ReadOnly = false in the table schema) can be updated.
Columns
| Name | Type | ReadOnly | Description |
| Id [KEY] | String | True |
Unique identifier for the lead. |
| Latitude | Double | False |
Latitude coordinate of the lead's address. |
| Longitude | Double | False |
Longitude coordinate of the lead's address. |
| Owner_Id | String | False |
Unique identifier of the lead owner. |
| Owner_FirstName | String | True |
First name of the lead owner. |
| Owner_LastName | String | True |
Last name of the lead owner. |
| Owner_Email | String | True |
Email address of the lead owner. |
| Company | String | False |
Name of the company associated with the lead. |
| First_Name | String | False |
First name of the lead. |
| Last_Name | String | False |
Last name of the lead. |
| Full_Name | String | False |
Full name of the lead. |
| Designation | String | False |
Job title of the lead. |
| String | False |
Email address of the lead. | |
| Phone | String | False |
Primary phone number of the lead. |
| Fax | String | False |
Fax number of the lead. |
| Mobile | String | False |
Mobile number of the lead. |
| Website | String | False |
Website associated with the lead. |
| Lead_Source | String | False |
Source from which the lead originated. |
| Lead_Status | String | False |
Current status of the lead. |
| Industry | String | False |
Industry in which the lead operates. |
| No_of_Employees | Int | False |
Number of employees in the lead's company. |
| Annual_Revenue | Decimal | False |
Annual revenue of the lead's company. |
| Rating | String | False |
Rating of the lead. |
| Email_Opt_Out | Bool | False |
Indicates whether the lead has opted out of email communication. |
| Skype_ID | String | False |
Skype Id of the lead. |
| Created_By_Id | String | False |
Unique identifier of the user who created the lead. |
| Modified_By_Id | String | False |
Unique identifier of the user who last modified the lead. |
| Modified_By_FirstName | String | True |
First name of the user who last modified the lead. |
| Modified_By_LastName | String | True |
Last name of the user who last modified the lead. |
| Modified_By_Email | String | True |
Email address of the user who last modified the lead. |
| Created_Time | Datetime | False |
Date and time when the lead was created. |
| Modified_Time | Datetime | False |
Date and time when the lead was last modified. |
| Salutation | String | False |
Salutation used for the lead. |
| Secondary_Email | String | False |
Secondary email address of the lead. |
| Last_Activity_Time | Datetime | True |
Date and time of the last activity related to the lead. |
| String | False |
Twitter handle of the lead. | |
| Tag | String | False |
Tags associated with the lead. |
| Description | String | False |
Additional notes or description about the lead. |
| Record_Image | String | False |
Profile image of the lead. |
| Converted_Date_Time | Datetime | False |
Date and time when the lead was converted. |
| Lead_Conversion_Time | Int | True |
Time taken to convert the lead, in minutes. |
| Unsubscribed_Mode | String | True |
Mode by which the lead unsubscribed from communications. |
| Unsubscribed_Time | Datetime | True |
Date and time when the lead unsubscribed. |
| Converted_Account_Id | String | False |
Unique identifier of the account the lead was converted to. |
| Converted_Contact_Id | String | False |
Unique identifier of the contact the lead was converted to. |
| Converted_Deal_Id | String | False |
Unique identifier of the deal the lead was converted to. |
| Id_CustomModule | Long | True |
Internal record identifier. |
| Change_Log_Time__s | Datetime | True |
Timestamp when the record was last included in the change log. |
| Converted__s | Bool | True |
Indicates whether the lead has been converted. |
| Locked__s | Bool | True |
Indicates whether the lead record is locked for editing. |
| Last_Enriched_Time__s | Datetime | True |
Timestamp when the lead was last enriched. |
| Enrich_Status__s | String | True |
Status of the lead enrichment process. |
| Country | String | False |
Country of the lead's address. |
| Flat_House_No_Building_Apartment_Name | String | False |
Flat/house number, building, or apartment name portion of the lead's address. |
| Street | String | False |
Street address of the lead. |
| City | String | False |
City of the lead's address. |
| State | String | False |
State of the lead's address. |
| Zip_Code | String | False |
Postal code of the lead's address. |
| Last_Visited_Time | Datetime | True |
Date and time when the lead most recently visited your website or tracked page. |
| First_Visited_URL | String | True |
URL of the first webpage the lead visited during their initial tracked session. |
| Average_Time_Spent_Minutes | Double | True |
Average duration in minutes the lead spends per visit on tracked pages. |
| Number_Of_Chats | Int | True |
Total number of chat interactions initiated by or with the lead. |
| Referrer | String | True |
Source or referring site/channel that directed the lead to your website. |
| Visitor_Score | Long | True |
Engagement score assigned to the lead based on their tracked website activity. |
| First_Visited_Time | Datetime | True |
Date and time when the lead first visited your website or tracked page. |
| Days_Visited | Int | True |
Count of distinct days on which the lead visited tracked pages. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer more granular control over the data returned from the data source.
| Name | Type | Description |
| DuplicateCheckFields | String |
The field(s) to be used for checking duplicate records in an upsert. The REST API allows for more than one field in the duplicate check but the BULK API only allows one field. |
| Trigger | String |
To trigger the rule while inserting record into CRM account. |