The Leads module contains methods to create and manage leads or list subscribers.

Using this module requires including the name “leads” in the url, like so:[keyid]&AccessKey=[key]&[otherparams]

For more details on how to begin using the Marketing Automation API, see our Getting Started guide.

Below are all the methods currently included in the leads module. Click on the method name to see full documentation for each.

Method Description
GetLeads Fetch all leads for a specific User/Project
GetLeadBrief Fetch a summary of a specific lead
GetLead Fetch data on a specific lead
GetLeadDetailed Fetch detailed info about a lead
GetLead_ByForeignKey Fetch a lead based on a foreign key
GetLead_ByContact Fetch a lead by specified contact type
AddLead Add a new Lead to a Project
UpdateLead Update an existing lead in a Project
DeleteLead Delete a lead from a Project
GetLeadContacts Fetch all types of Contact for a Lead
GetLeadContact Fetch a specified type of Contact for a Lead
GetLeadContacts_ByContact Fetch all types of Contact for a Lead by a specified Contact
GetLeadContact_ByContact Fetch a specific type of Contact for a Lead by a Contact
AddLeadContact Add a new Contact for a Lead
VerifyLeadContact Verify a specific Contact for a Lead
GetLeadID_ByLeadContactID Fetch the LeadID by the ContactLeadID
GetLeadContactID_ByVerifiedContact Fetch the LeadContactID by a verified Contact
GetLeadContactID_ByPrimaryContact Fetch ContactID for a Lead by the primary Contact
GetLeadID_ByVerifiedContact Fetch the LeadID by a verified Contact
GetLeadID_ByPrimaryContact Fetch the LeadID by the primary Contact
Subscribe Add a subscriber to a List
GetLeadSubscription Fetch all data about a specific subscription
GetLeadSubscription_ByDetails Fetch all data about a subscription by a particular lead detail
GetLeadSubscriptionID_ByDetails Fetch SubscriptionID for a Lead by a particular lead detail
SubscriptionVerify Verify a subscription
SubscriptionVerify_ByDetails Verify a subscription by a particular lead detail
Unsubscribe Cancel subscription to a List
AddLeadTags Add tags to a Lead
RemoveLeadTags Remove tags from a Lead
Milestone Log a milestone event
Buy Log a buy event
Score Set or update a Lead Score
VerifyLeadOwnership verify ownership of a Lead
VerifyLeadContactOwnership Verify ownership of a Contact for a Lead