Leads Module

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:


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.

GetLeadsFetch all leads for a specific User/Project
GetLeadBriefFetch a summary of a specific lead
GetLeadFetch data on a specific lead
GetLeadDetailedFetch detailed info about a lead
GetLead_ByForeignKeyFetch a lead based on a foreign key
GetLead_ByContactFetch a lead by specified contact type
AddLeadAdd a new Lead to a Project
UpdateLeadUpdate an existing lead in a Project
DeleteLeadDelete a lead from a Project
GetLeadContactsFetch all types of Contact for a Lead
GetLeadContactFetch a specified type of Contact for a Lead
GetLeadContacts_ByContactFetch all types of Contact for a Lead by a specified Contact
GetLeadContact_ByContactFetch a specific type of Contact for a Lead by a Contact
AddLeadContactAdd a new Contact for a Lead
VerifyLeadContactVerify a specific Contact for a Lead
GetLeadID_ByLeadContactIDFetch the LeadID by the ContactLeadID
GetLeadContactID_ByVerifiedContactFetch the LeadContactID by a verified Contact
GetLeadContactID_ByPrimaryContactFetch ContactID for a Lead by the primary Contact
GetLeadID_ByVerifiedContactFetch the LeadID by a verified Contact
GetLeadID_ByPrimaryContactFetch the LeadID by the primary Contact
SubscribeAdd a subscriber to a List
GetLeadSubscriptionFetch all data about a specific subscription
GetLeadSubscription_ByDetailsFetch all data about a subscription by a particular lead detail
GetLeadSubscriptionID_ByDetailsFetch SubscriptionID for a Lead by a particular lead detail
SubscriptionVerifyVerify a subscription
SubscriptionVerify_ByDetailsVerify a subscription by a particular lead detail
UnsubscribeCancel subscription to a List
AddLeadTagsAdd tags to a Lead
RemoveLeadTagsRemove tags from a Lead
MilestoneLog a milestone event
BuyLog a buy event
ScoreSet or update a Lead Score
VerifyLeadOwnershipverify ownership of a Lead
VerifyLeadContactOwnershipVerify ownership of a Contact for a Lead