Lead Gen & CRM has a distinct API organization.
This article will detail the methods listed within the Lead Gen & CRM API.
Trial | ||
Essential | ||
Advanced | ✓ | |
Ultimate | ✓ |
Administrators | ✓ | |
Company Managers | ||
Marketing Managers | ||
Sales Managers | ||
Salespersons | ||
Jr. Salespersons |
Article Contents
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:
Method List
The following methods are available within the Lead Gen & CRM API:
Method | Module | Table | ||
createAccounts | Core |
Account |
||
deleteAccounts | Core |
Account |
||
getAccount | Core |
Account |
||
getAccounts | Core |
Account |
||
getAccountsDateRange | Core |
Account |
||
updateAccounts | Core |
Account |
||
createCampaigns | Core |
Campaign |
||
deleteCampaigns | Core |
Campaign |
||
getCampaign | Core |
Campaign |
||
getCampaigns | Core |
Campaign |
||
getCampaignsDateRange | Core |
Campaign |
||
updateCampaigns | Core |
Campaign |
||
getClients | Core |
Company Profile Managed By |
||
createSendMail | Core |
CreateSendEmail |
||
createDealStages | Core |
DealStage |
||
deleteDealStages | Core |
DealStage |
||
getDealStage | Core |
DealStage |
||
getDealStages | Core |
DealStage |
||
getDealStagesDateRange | Core |
DealStage |
||
createEmail | Core |
|
||
deleteEmail | Core |
|
||
getEmail | Core |
|
||
getEmailListing | Core |
|
||
updateEmail | Core |
|
||
deleteScheduleSend | Core |
EmailJob |
||
getEmailEvents | Core |
EmailJob |
||
getEmailSendEvents | Core |
EmailJob |
||
getEmailSendStatus | Core |
EmailJob |
||
getScheduleSendStatus | Core |
EmailJob |
||
getScheduleSends | Core |
EmailJob |
||
getSendCount | Core |
EmailJob |
||
getEvents | Core |
Event |
||
createFields | Core |
Field |
||
deleteFields | Core |
Field |
||
getFields | Core |
Field |
||
updateFields | Core |
Field |
||
getRelatedLeadsByEmail | Core |
Form Event History |
||
getListTags | Core |
GetListTags |
||
createLeads | Core |
Lead |
||
deleteLeads | Core |
Lead |
||
getLead | Core |
Lead |
||
getLeads | Core |
Lead |
||
getLeadsDateRange | Core |
Lead |
||
subscribeToLeadUpdates | Core |
Lead |
||
updateLeads | Core |
Lead |
||
updateLeadsV2 | Core |
Lead |
||
createList | Core |
List |
||
deleteList | Core |
List |
||
getActiveLists | Core |
List |
||
updateList | Core |
List |
||
addListMember | Core |
ListMember |
||
addListMemberEmailAddress | Core |
ListMember |
||
addListMembers |
Core |
ListMember | ||
addListMembersEmailAddress | Core |
ListMember |
||
getContactListMemberships | Core |
ListMember |
||
getEmailSend | Core |
ListMember |
||
getListMemberships | Core |
ListMember |
||
removeListMember | Core |
ListMember |
||
removeListMemberEmailAddress | Core |
ListMember |
||
removeListMembers | Core |
ListMember |
||
removeListMembersEmailAddress | Core |
ListMember |
||
removeListMembersAll | Core |
ListMembers |
||
createOpportunities | Core |
Opportunity |
||
deleteOpportunities | Core |
Opportunity |
||
getOpportunities | Core |
Opportunity |
||
getOpportunitiesDateRange | Core |
Opportunity |
||
getOpportunity | Core |
Opportunity |
||
updateOpportunities | Core |
Opportunity |
||
createOpportunityLeads | Core |
OpportunityLead |
||
deleteOpportunityLeads | Core |
OpportunityLead |
||
getOpportunityLead | Core |
OpportunityLead |
||
getOpportunityLeads | Core |
OpportunityLead |
||
getOpportunityLeadsDateRange | Core |
OpportunityLead |
||
getUnsubscribeCategories | Core |
Unsubscribe Category |
||
getUserProfiles | Core |
UserProfile |
||
updateAccountSendLimit | Core |
accountSendLimit |
||
createClient | Core |
companyProfile |
||
updateClient | Core |
companyProfileUpdate |
||
disableAccountSending | Core |
disableAccountSending |
||
enableAccountSending | Core |
enableAccountSending |
||
logCalls | Core |
eventHistory |
||
getEmailJobs | Core |
getemailjob |
||
getLeadListMemberships | Core |
listLeadMembership |
||
getLeadTimeline | Core |
leadTimeline |
||
getRemovedListMembers | Core |
listLeadMember |
||
getListMembers | Core |
listMembers |
Account
createAccounts |
Specifies a list of Account objects to be created in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<account> | Required | ||||
Return Data |
Name | Type | ||||
creates |
list<createResult> |
deleteAccounts |
Specifies a list of Account IDs to be deleted in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<id> | Required | ||||
Return Data |
Name | Type | ||||
deletes |
list<deleteResult> |
getAccount |
Retrieves a single Account by its ID. |
|||||
Params | Name | Type | Is Required | |||
id |
int | Required | ||||
Return Data |
Name | Type | ||||
accounts |
list<Account> |
getAccounts |
Retrieves a list of Accounts given a WHERE clause, or retrieves all Accounts if WHERE clause is empty. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
limit |
int | Optional | ||||
offset | int |
Optional |
||||
Return Data |
Name | Type | ||||
accounts |
list<Account> |
getAccountsDateRange |
Retrieves a list of Accounts that have been either created or updated between two timestamps. Timestamps must be specified in Y-m-d H:i:s format. |
|||||
Params | Name | Type | Is Required | |||
startDate | timestamp |
Required |
||||
endDate | timestamp |
Required |
||||
timestamp |
string |
Required | ||||
Return Data |
Name | Type | ||||
Accounts |
list<Account> |
updateAccounts |
Specifies a list of Account objects to be updated in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<account> | Required | ||||
Return Data |
Name | Type | ||||
updates |
list<updateResult> |
Campaign
createCampaigns |
Specifies a list of Campaign objects to be created in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<campaign> | Required | ||||
Return Data |
Name | Type | ||||
creates |
list<createResult> |
deleteCampaigns |
Specifies a list of Campaign IDs to be deleted in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects | list<id> |
Required |
||||
Return Data |
Name | Type | ||||
deletes |
list<deleteResult> |
getCampaign |
Retrieves a single Campaign by its ID. |
|||||
Params | Name | Type | Is Required | |||
id |
int |
Required | ||||
Return Data |
Name | Type | ||||
campaigns |
list<Campaign> |
getCampaigns |
Retrieves a list of Campaigns given a WHERE clause, or retrieves all Campaigns if WHERE clause is empty. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
limit | int |
Optional |
||||
offset | int |
Optional |
||||
Return Data |
Name | Type | ||||
campaigns |
list<Campaign> |
getCampaignsDateRange |
Retrieves a list of Campaigns that have been either created or updated between two timestamps. Timestamps must be specified in Y-m-d H:i:s format. |
|||||
Params | Name | Type | Is Required | |||
startDate |
timestamp | Required | ||||
endDate |
timestamp | Required | ||||
timestamp |
string |
Required | ||||
Return Data |
Name | Type | ||||
Campaigns |
list<Campaign> |
updateCampaigns |
Specifies a list of Campaign objects to be updated in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects | list<campaign> |
Required |
||||
Return Data |
Name | Type | ||||
updates |
list<updateResult> |
Company Profile Managed By
getClients |
Gets a list of all active companies managed by your company. |
|||||
Params | Name | Type | Is Required | |||
None listed |
||||||
Return Data |
Name | Type | ||||
getAllcompanyProfileManagedBys |
list<Client> |
CreateSendEmail
createSendMail |
Sends an email to a list or lists of a specific tag. |
|||||
Params | Name | Type | Is Required | |||
objects | list<ScheduleSend> |
Required |
||||
Return Data |
Name | Type | ||||
actions |
list<CreateResult> |
DealStage
createDealStages |
Specifies a list of DealStage objects to be created in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects | list<dealStage> |
Required |
||||
Return Data |
Name | Type | ||||
creates |
list<createResult> |
deleteDealStages |
Specifies a list of DealStage IDs to be deleted in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<id> |
Required | ||||
Return Data |
Name | Type | ||||
deletes |
list<deleteResult> |
getDealStage |
Retrieves a single DealStage by its ID. |
|||||
Params | Name | Type | Is Required | |||
id | int |
Required |
||||
Return Data |
Name | Type | ||||
dealStages |
list<DealStage> |
getDealStages |
Retrieves a list of DealStage objects given a WHERE clause, or retrieves all DealStage objects if WHERE clause is empty. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
limit | int |
Optional |
||||
offset | int |
Optional |
||||
Return Data |
Name | Type | ||||
dealStages |
list<DealStage> |
getDealStagesDateRange |
Retrieves a list of DealStages that have been either created or updated between two timestamps. Timestamps must be specified in Y-m-d H:i:s format. |
|||||
Params | Name | Type | Is Required | |||
startDate | timestamp |
Required |
||||
endDate | timestamp |
Required |
||||
timestamp |
string |
Required | ||||
Return Data |
Name | Type | ||||
DealStages |
list<DealStage> |
Email
createEmail |
Creates an email from HTML. |
|||||
Params | Name | Type | Is Required | |||
objects | list<Email> |
Required |
||||
Return Data |
Name | Type | ||||
actions |
list<CreateResult> |
deleteEmail |
Specifies an email ID to be deleted in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<id> | Required | ||||
Return Data |
Name | Type | ||||
actions |
list<DeleteResult> |
getEmail |
Returns the requested email HTML data. |
|||||
Params | Name | Type | Is Required | |||
id |
int |
Required | ||||
Return Data |
Name | Type | ||||
fields |
Returns just the HTML data |
getEmailListing |
Returns a list of email information. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Optional | ||||
limit |
int |
Optional | ||||
offset |
int |
Optional | ||||
Return Data |
Name | Type | ||||
fields |
list<emailListing> |
updateEmail |
Specifies a list of existing Emails to be updated in Lead Gen & CRM. The ID of each email must be passed for each record being updated. |
|||||
Params | Name | Type | Is Required | |||
object |
list<Email> |
Required | ||||
Return Data |
Name | Type | ||||
actions |
list<UpdateResult> |
EmailJob
deleteScheduleSend |
Deletes an email job scheduled to send to a list or a lead. |
|||||
Params | Name | Type | Is Required | |||
jobID |
int | Required | ||||
Return Data |
Name | Type | ||||
deletes |
list<DeleteResult> |
getEmailEvents |
Retrieves email statistics by jobID. Optionally filter to event type. Allowed values for eventType are clicks, opens, bounces, sends, and unsubscribes. |
|||||
Params | Name | Type | Is Required | |||
emailJobID |
int | Required | ||||
eventType |
string | Required | ||||
Return Data |
Name | Type | ||||
events |
list<EmailEvent> |
getEmailSendEvents |
Retrieves email sends for a given email job. |
|||||
Params | Name | Type | Is Required | |||
sendID |
int | Required | ||||
eventType |
string [sends, opens, clicks, bounces, spam, unsubscribes] |
Required | ||||
limit |
int |
Required | ||||
startingAfter |
int [eventID] |
Optional | ||||
Return Data |
Name | Type | ||||
events |
list<EmailSendEvent> | |||||
hasMore |
boolean |
getEmailSendStatus |
Retrieves a status determining whether an email job has been sent or is in queue. |
|||||
Params | Name | Type | Is Required | |||
sendID |
int | Required | ||||
Return Data |
Name | Type | ||||
status |
n/a |
getScheduleSendStatus |
Retrieves the send status of a scheduled email job. |
|||||
Params | Name | Type | Is Required | |||
jobID |
int | Required | ||||
limit |
int | Optional | ||||
offset |
int | Optional | ||||
Return Data |
Name | Type | ||||
automationEventQueue |
id, taskID, workflowID, timeProcessed, processed, workflowEventData, sendDuplicate, email {id, companyID, fromEmail, fromName, subject, title}, whoID, whoType, whatID, whatType, createTimestamp |
getScheduleSends |
Retrieves email jobs scheduled to send by list, lead, email, or job. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
Return Data |
Name | Type | ||||
sends |
list<ScheduleSendQueue> |
getSendCount |
Retrieves email send counts by date range and companyID for agency and client accounts. |
|||||
Params | Name | Type | Is Required | |||
fromDate |
timestamp | Required | ||||
toDate |
timestamp | Required | ||||
companyID |
int | Optional | ||||
Return Data |
Name | Type | ||||
sendCounts |
list<companyID, sendCount> |
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> |
Field
createFields |
Specifies a list of field objects to be created in Lead Gen & CRM. Each field must, at minimum, have a relationship (such as opportunity, lead, or account), dataType (such as text or picklist), and label. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<Field> | Required | ||||
Return Data |
Name | Type | ||||
creates |
list<CreateResult> |
deleteFields |
Specifies a list of fields to be deleted in Lead Gen & CRM. Only custom fields can be deleted. These fields are deleted by systemName. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<systemName> | Required | ||||
Return Data |
Name | Type | ||||
deletes |
list<deleteResult> |
getFields |
Retrieves a list of Field objects. This function is extremely useful for retrieving a list of all custom fields and system fields available in Lead Gen & CRM. Every result will have a systemName, which is the key that must be specified in order to update that field for a specific lead. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
limit |
int |
Optional | ||||
offset |
int |
Optional | ||||
Return Data |
Name | Type | ||||
fields |
list<Field> |
updateFields |
Specifies a list of existing Fields to be updated in Lead Gen & CRM. The ID of each field must be passed for each record being updated. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<Field> | Required | ||||
Return Data |
Name | Type | ||||
updates |
list<updateResult> |
Form Event History
getRelatedLeadsByEmail |
Retrieves an ordered set of Form Event History records via an email. Useful for de-duping leads in your own CRM. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
limit |
int |
Optional | ||||
offset |
int |
Optional | ||||
Return Data |
Name | Type | ||||
fields |
list<FormEventHistory> |
GetListTags
getListTags |
Returns a tag list for lists. |
|||||
Params | Name | Type | Is Required | |||
none |
Optional | |||||
Return Data |
Name | Type | ||||
result |
list<listTag> |
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> |
List
createList |
Creates a static mailing list. |
|||||
Params | Name | Type | Is Required | |||
name |
string |
Required | ||||
description |
string |
Optional | ||||
Return Data |
Name | Type | ||||
status |
boolean<true/false> |
|||||
id |
int |
deleteList |
Specifies a list of Lists 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> |
getActiveLists |
Returns a list of active Lists. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
limit |
int |
Optional | ||||
offset |
int |
Optional | ||||
Return Data |
Name | Type | ||||
activeList |
list<List> |
updateList |
Updates an existing list. |
|||||
Params | Name | Type | Is Required | |||
id |
int | Required | ||||
name |
string | Optional | ||||
description |
string | Optional | ||||
Return Data |
Name | Type | ||||
updates |
list<UpdateResult> |
ListMember
addListMember |
Adds a lead to a list. |
|||||
Params | Name | Type | Is Required | |||
listID |
int | Required | ||||
memberID |
int | Required | ||||
Return Data |
Name | Type | ||||
creates |
list<createResult> |
addListMemberEmailAddress |
Adds a member to a mailing list using their email address. |
|||||
Params | Name | Type | Is Required | |||
listID |
int | Required | ||||
emailAddress |
string | Required | ||||
Return Data |
Name | Type | ||||
create |
list<CreateResult> |
addListMembers |
Specifies a list of leads by ID and lists for managing memberships in bulk. Each call can handle up to 500 associations. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<listID, memberID> | Required | ||||
Return Data |
Name | Type | ||||
creates |
list<createResult> |
addListMembersEmailAddress |
Specifies a list of leads by email address and lists for managing memberships in bulk. Each call can handle up to 500 associations. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<listID, emailAddress> | Required | ||||
Return Data |
Name | Type | ||||
creates |
list<createResult> |
getContactListMemberships |
Gets the lists that a particular contact is a member of. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
Return Data |
Name | Type | ||||
listMember |
list<ListMember> |
getEmailSend |
Retrieves all aggregate data for an email job. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
Return Data |
Name | Type | ||||
EmailSend |
list<EmailSend> |
getListMemberships |
Gets the lists that a particular contact is a member of by email address. |
|||||
Params | Name | Type | Is Required | |||
emailAddress |
string | Required | ||||
Return Data |
Name | Type | ||||
ListMembership |
list<ListMembership> |
removeListMember |
Removes a lead from a list. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
Return Data |
Name | Type | ||||
updates |
list<updateResult> |
removeListMemberEmailAddress |
Removes a member from a mailing list using their email address. |
|||||
Params | Name | Type | Is Required | |||
listID |
int | Required | ||||
emailAddress |
string | Required | ||||
Return Data |
Name | Type | ||||
deletes |
list<deleteResult> |
removeListMembers |
Specifies a list of leads by id and lists for managing memberships in bulk. Each call can handle up to 500 updates. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<listID, memberID> | Required | ||||
Return Data |
Name | Type | ||||
updates |
list<updateResult> |
removeListMembersEmailAddress |
Specifies a list of leads by email address and lists for managing memberships in bulk. Each call can handle up to 500 updates. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<listID, emailAddress> | Required | ||||
Return Data |
Name | Type | ||||
updates |
list<updateResult> |
ListMembers
removeListMembersAll |
Removes all members from a static list that were not manually added. Code is the HTTP code representing the status of the request, and Message is the accompanying description of the code. |
|||||
Params | Name | Type | Is Required | |||
id |
int |
Required | ||||
Return Data |
Name | Type | ||||
result |
code, message |
Opportunity
createOpportunities |
Specifies a list of Opportunity objects to be created in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<opportunity> | Required | ||||
Return Data |
Name | Type | ||||
creates |
list<createResult> |
deleteOpportunities |
Specifies a list of Opportunity IDs to be deleted in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<id> | Required | ||||
Return Data |
Name | Type | ||||
deletes |
list<deleteResult> |
getOpportunities |
Retrieves a list of Opportunities given a WHERE clause, or retrieves all Opportunities if WHERE clause is empty. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
limit |
int |
Optional | ||||
offset |
int |
Optional | ||||
Return Data |
Name | Type | ||||
opportunity |
list<Opportunity> |
getOpportunitiesDateRange |
Retrieves a list of Opportunities that have been either created or updated between two timestamps. Timestamps must be specified in Y-m-d H:i:s format. |
|||||
Params | Name | Type | Is Required | |||
startDate |
timestamp | Required | ||||
endDate |
timestamp | Required | ||||
timestamp |
string |
Required | ||||
Return Data |
Name | Type | ||||
opportunity |
list<Opportunity> |
getOpportunity |
Retrieves a single Opportunity by its ID. |
|||||
Params | Name | Type | Is Required | |||
id |
int | Required | ||||
Return Data |
Name | Type | ||||
opportunities |
list<Opportunity> |
updateOpportunities |
Specifies a list of Opportunity objects to be updated in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<opportunity> | Required | ||||
Return Data |
Name | Type | ||||
updates |
list<updateResult> |
OpportunityLead
createOpportunityLeads |
Specifies a list of OpportunityLead objects to be created in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects |
list<OpportunityLead> | Required | ||||
Return Data |
Name | Type | ||||
creates |
list<createResult> |
deleteOpportunityLeads |
Specifies a list of OpportunityLead IDs to be deleted in Lead Gen & CRM. |
|||||
Params | Name | Type | Is Required | |||
objects | list<id> |
Required |
||||
Return Data |
Name | Type | ||||
deletes |
list<deleteResult> |
getOpportunityLead |
Retrieves a single OpportunityLead by its ID. |
|||||
Params | Name | Type | Is Required | |||
id |
int | Required | ||||
Return Data |
Name | Type | ||||
opportunityLeads |
list<OpportunityLead> |
getOpportunityLeads |
Retrieves a list of OpportunityLead objects given a WHERE clause, or retrieves all OpportunityLead objects if WHERE clause is empty. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
limit |
int |
Optional | ||||
offset | int |
Optional |
||||
Return Data |
Name | Type | ||||
opportunityLeads |
list<OpportunityLeads> |
getOpportunityLeadsDateRange |
Retrieves a list of OpportunityLeads that have been either created or updated between two timestamps. Timestamps must be specified in Y-m-d H:i:s format. |
|||||
Params | Name | Type | Is Required | |||
startDate | timestamp |
Required |
||||
endDate | timestamp |
Required |
||||
timestamp |
string |
Required | ||||
Return Data |
Name | Type | ||||
OpportunityLeads |
list<OpportunityLead> |
Unsubscribe Category
getUnsubscribeCategories |
Gets a list of unsubscribe categories. |
|||||
Params | Name | Type | Is Required | |||
none |
Optional | |||||
Return Data |
Name | Type | ||||
getAllUnsubscribeCategories |
list<UnsubscribeCategory> |
UserProfile
getUserProfiles |
Retrieves a list of UserProfile objects. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Optional | ||||
limit |
int |
Optional | ||||
offset |
int |
Optional | ||||
Return Data |
Name | Type | ||||
userProfiles |
list<UserProfile> |
accountSendLimit
updateAccountSendLimit |
Updates the send limit of a subaccount. |
|||||
Params | Name | Type | Is Required | |||
clientID |
int | Required | ||||
emailLimit |
int | Required | ||||
Return Data |
Name | Type | ||||
updates |
list<UpdateResult> |
companyProfile
createClient |
Creates a subclient for agencies. country: This value is based on ISO 3166-1 alpha-2 standard. Examples include US, UK, and IT. locale: Optional. This value is responsible for your language and needs to be one of the following: |
|||||
• en_US • de_DE • es_ES • fr_FR • it_IT |
• nl_NL • pt_PT • ro_RO • sk_SK • tr_TR |
|||||
salesStartHour: Based on a 24-hour clock. 00h to 24h. salesEndHour: Based on a 24-hour clock. 00h to 24h. Adding a username and password will create a new user for that profile. |
||||||
Params | Name | Type | Is Required | |||
companyName |
string | Required | ||||
streetAddress |
string | Optional | ||||
zipCode |
string | Optional | ||||
country |
string | Optional | ||||
state |
string | Optional | ||||
city |
string | Optional | ||||
salesPhone |
string | Required | ||||
defaultCurrency |
string | Optional | ||||
locale |
string | Optional | ||||
salesStartHour |
int | Optional | ||||
salesEndHour |
int | Optional | ||||
salesOfficialTimeZone |
string | Optional | ||||
disallowClientRebrand |
boolean | Optional | ||||
hideGoogleAdWords |
boolean | Optional | ||||
displayCallTrackingSettings |
boolean | Optional | ||||
userEmail |
string | Optional | ||||
userPassword |
string | Optional | ||||
userDisplayName |
string | Optional | ||||
Return Data |
Name | Type | ||||
status |
boolean | |||||
error |
array | |||||
userID |
int | |||||
id |
int |
companyProfileUpdate
updateClient |
Updates a subclient for agencies. country: This value is based on ISO 3166-1 alpha-2 standard. Examples include US, UK, and IT. locale: Optional. This value is responsible for your language and needs to be one of the following: |
|||||
• en_US • de_DE • es_ES • fr_FR • it_IT |
• nl_NL • pt_PT • ro_RO • sk_SK • tr_TR |
|||||
salesStartHour: Based on a 24-hour clock. 00h to 24h. salesEndHour: Based on a 24-hour clock. 00h to 24h. |
||||||
Params | Name | Type | Is Required | |||
id |
int | Required | ||||
streetAddress |
string | Optional | ||||
zipCode |
string | Optional | ||||
country |
string | Optional | ||||
state |
string | Optional | ||||
city |
string | Optional | ||||
salesPhone |
string | Optional | ||||
defaultCurrency |
string | Optional | ||||
locale |
string | Optional | ||||
salesStartHour |
int | Optional | ||||
salesEndHour |
int | Optional | ||||
salesOfficialTimeZone |
string | Optional | ||||
disallowClientRebrand |
boolean | Optional | ||||
hideGoogleAdWords |
boolean | Optional | ||||
displayCallTrackingSettings |
boolean | Optional | ||||
Return Data |
Name | Type | ||||
updates |
list<UpdateResult> |
disableAccountSending
disableAccountSending |
Disables a subaccount's sending. |
|||||
Params | Name | Type | Is Required | |||
clientID |
int | Required | ||||
Return Data |
Name | Type | ||||
updates |
list<UpdateResult> |
enableAccountSending
enableAccountSending |
Enables a subaccount's sending. |
|||||
Params | Name | Type | Is Required | |||
clientID | int |
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 |
getemailjob
getEmailJobs |
Gets a list of active email jobs for the current account. |
|||||
Params | Name | Type | Is Required | |||
limit |
string |
Optional | ||||
offset |
string |
Optional | ||||
Return Data |
Name | Type | ||||
getAllgetEmailJobs |
list<EmailJob> |
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> |
listLeadMember
getRemovedListMembers |
Gets the members of a list that are removed, unsubscribed, or hardbounced. If none of these are supplied via the flag parameter, then it will default to removed. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
limit |
int | Optional | ||||
offset |
int | Optional | ||||
Return Data |
Name | Type | ||||
getWherelistLeadMembers |
list<RemovedListMember> |
listMembers
getListMembers |
Returns the active members for a specific list. |
|||||
Params | Name | Type | Is Required | |||
where |
hash |
Required | ||||
limit |
int |
Optional | ||||
offset |
int |
Optional | ||||
Return Data |
Name | Type | ||||
fields |
list<List> |