Lead Gen & CRM has a distinct API organization.
This article will detail the methods listed within the Lead Gen & CRM API, related to Leads.
Article Contents
Available With:
| Trial | ||
| Essential | ||
| Advanced | ||
| Ultimate | ✓ |
SettingsUsers:
| Administrators | ✓ | |
| Company Managers | ||
| Marketing Managers | ||
| Sales Managers | ||
| Salespersons | ||
| Jr. Salespersons |
Additional API Information
This article provides specific method content about Lead Gen & CRM's API. However, given the size and scope of the API, information is broken up and is contained in different articles. Each article focuses on a specific function of Lead Gen & CRM's API. Additional API information can be found in the following articles:
Event
getEvents |
Retrieves a list of Lead Gen & CRM Lead events. Either a lead ID or an event timestamp can be specified. In the case when an event timestamp is specified, the API will return all events that happened after the given timestamp. Please note that Mail Sync events will not be returned. |
|||||
| Params | Name | Type | Is Required | |||
| where |
hash |
Required | ||||
| limit |
int |
Optional | ||||
| offset |
int |
Optional | ||||
| Return Data |
Name | Type | ||||
|
fields |
list<Event> | |||||
Lead
createLeads |
Specifies a list of Lead objects to be created in Lead Gen & CRM. Every lead object is a hash-keyed by the system name of the lead field. If you wish to push custom fields, first use the getFields API method in order to retrieve a list of custom fields. In order to set a custom field for a lead, use the field's systemName attribute as the key. This method accepts up to 500 lead objects per call. However, in instances with a great deal of of custom field data being passed, it is better to separate the requests into smaller, more manageable calls to improve performance. 250 lead objects should be used in those cases. |
|||||
| Params | Name | Type | Is Required | |||
|
objects |
list<lead> | Required | ||||
| Return Data |
Name | Type | ||||
|
creates |
list<createResult> | |||||
deleteLeads |
Specifies a list of leads to be deleted in Lead Gen & CRM by ID. |
|||||
| Params | Name | Type | Is Required | |||
|
objects |
list<id> | Required | ||||
| Return Data |
Name | Type | ||||
|
deletes |
list<deleteResult> | |||||
getLead |
Retrieves a single Lead by its ID. |
|||||
| Params | Name | Type | Is Required | |||
|
id |
int | Required | ||||
| Return Data |
Name | Type | ||||
| leads |
list<Lead> |
|||||
getLeads |
Retrieves a list of Leads given a WHERE clause, or retrieves all Leads if WHERE clause is empty. If a list is used in the parameters, then non-list parameters will be ignored. A maximum of 500 leads will be returned with list ID being selected first. If FIELDS is specified, only the fields requested will be returned. |
|||||
| Params | Name | Type | Is Required | |||
| where |
hash |
Required | ||||
|
limit |
int | Optional | ||||
|
offset |
int | Optional | ||||
|
fields |
list<systemName> | Optional | ||||
| Return Data |
Name | Type | ||||
|
leads |
list<Lead> | |||||
getLeadsDateRange |
Retrieves a list of Leads that have been either created or updated between two timestamps. Timestamps must be specified in Y-m-d H:i:s format. If FIELDS is specified, only the fields requested will be returned. |
|||||
| Params | Name | Type | Is Required | |||
| startDate |
timestamp |
Required | ||||
| endDate |
timestamp |
Required | ||||
| timestamp |
string |
Required | ||||
| fields |
list<systemName> |
Optional | ||||
| Return Data |
Name | Type | ||||
|
leads |
list<Lead> | |||||
subscribeToLeadUpdates |
Subscribes a URL to receive real-time lead updates. Lead Gen & CRM will POST a list of updated leads whenever leads are updated in the application. |
|||||
| Params | Name | Type | Is Required | |||
| url |
string |
Required | ||||
| Return Data |
Name | Type | ||||
| success |
boolean |
|||||
updateLeads |
Specifies a list of Lead objects to be updated in Lead Gen & CRM. Every lead object is a hash-keyed by the system name of the lead field. If you wish to push custom fields, first use the getFields API method in order to retrieve a list of custom fields. In order to set a custom field for a lead, use the field's systemName attribute as the key. |
|||||
| Params | Name | Type | Is Required | |||
| objects |
list<lead> |
Required | ||||
| Return Data |
Name | Type | ||||
| updates |
list<updateResult> |
|||||
updateLeadsV2 |
Specifies a list of Lead objects to be updated in Lead Gen & CRM. Every lead object is a hash-keyed by the system name of the lead field. If you wish to push custom fields, first use the getFields API method in order to retrieve a list of custom fields. In order to set a custom field for a lead, use the field's systemName attribute as the key. This differs from updateLeads in that it returns error code 404 if the lead ID does not exist or the lead ID is not provided and the lead email does not exist. |
|||||
| Params | Name | Type | Is Required | |||
|
objects |
list<lead> | Required | ||||
| Return Data |
Name | Type | ||||
|
updates |
list<updateResult> | |||||
eventHistory
logCalls |
Logs calls with leads. The timestamp must be specified in Y-m-d H:i:s format. |
|||||
| Params | Name | Type | Is Required | |||
|
objects |
list<CallLog> | Required | ||||
| Return Data |
Name | Type | ||||
|
success |
boolean | |||||
leadListMembership
getLeadListMemberships |
Gets the list IDs for each member ID. Maximum of 100 leads per request. |
|||||
| Params | Name | Type | Is Required | |||
|
memberIDs |
list<MemberID> | Required | ||||
| Return Data |
Name | Type | ||||
|
getWhereIns |
list<ListID> | |||||
leadTimeline
getLeadTimeline |
Gets lead event history. Can be filtered by providing constraints. Possible values for eventSource parameter: • emailOpened • formSubmit • emailVisit • importantPageVisit |
|||||
| Params | Name | Type | Is Required | |||
| where |
hash |
Required | ||||
| Return Data |
Name | Type | ||||
|
leadTimeline |
list<Event> | |||||