API Documentation


If you are looking for an API that provides lead data, please refer to LeadExec's Lead Data API for more information.

GetClientsForRedirect


Provides a list of available lead buyers for a lead that will return a redirect URL.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientsForRedirect
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientsForRedirect

Request Parameters

Name Type Description
Key String API access key
LeadUID Int64 Lead identifier to scan

Response Properties

Name Type Description
ClientUID Int64 The unique identifier for the client being returned
ClientAccountUID Int64 The unique identifier for the account being sent to
ClientOrderUID Int64 The unique identifier for the order this send will be applied to
ClientOrderItemUID Int64 The unique identifier for the item on the order this send will be applied to
Automation Boolean Should this send be logged as automated

GetClientsForTransfer


Provides a list of available lead buyers that have opted in for live call transfers.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientsForTransfer
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientsForTransfer

Request Parameters

Name Type Description
Key String API access key
LeadUID Int64 Lead identifier to scan

Response Properties

Name Type Description
ClientUID Int64 The unique identifier for the client being returned
ClientAccountUID Int64 The unique identifier for the account being sent to
ClientOrderUID Int64 The unique identifier for the order this send will be applied to
ClientOrderItemUID Int64 The unique identifier for the item on the order this send will be applied to
Automation Boolean Should this send be logged as automated


GetClientsForLead


Provides a list of available lead buyers that match the criteria of the lead


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientsForLead
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientsForLead

Request Parameters

Name Type Description
Key String API access key
LeadUID Int64 Unique identifier of lead to scan
Automated Boolean Include only automated delivery accounts
AllowOverMax Boolean Allow the system to deliver past the lead's maximum sell count

Response Properties

Name Type Description
ClientUID Int64 The unique identifier for the client being returned
ClientAccountUID Int64 The unique identifier for the account being sent to
ClientOrderUID Int64 The unique identifier for the order this send will be applied to
ClientOrderItemUID Int64 The unique identifier for the item on the order this send will be applied to
Automation Boolean Should this send be logged as automated


GetLeadScanLog


Returns an array of scan logs for a lead. The scan log contains all information that took place while determining the proper client to send to.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetLeadScanLog
Additional Information: https://api.leadexec.net/service.asmx?op=GetLeadScanLog

Request Parameters

Name Type Description
Key String API access key
LeadUID Int64 Unique identifier of the lead

Response Properties

Name Type Description
LeadUID Int64 The unique identifier of the lead assigned to this log
ScanDate DateTime The date the scan took place (Pacific Time)
Log String The details of the log


GetPromoCodes


Provides a list of all promo codes assigned to a reseller.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetPromoCodes
Additional Information: https://api.leadexec.net/service.asmx?op=GetPromoCodes

Request Parameters

Name Type Description
Key String API access key
ResellerUID Int64 Unique identifier of the reseller

Response Properties

Name Type Description
PromoUID Int64 The unique identifier for the promo code
ResellerUID Int64 The unique identifier of the reseller assigned
Code String The promo code
LeadPacks Array Array of unique identifiers for lead packs
MoneyValue Double The amount of money to be deducted from the lead pack total
PercentageValue Double The percentage of money to be deducted from the lead pack total


GetLeadPacks


Provides a list of lead packs.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetLeadPacks
Additional Information: https://api.leadexec.net/service.asmx?op=GetLeadPacks

Request Parameters

Name Type Description
Key String API access key
LeadPackUID Int64? Unique identifier of the lead pack (optional)
LeadPackCatUID Int64? Unique identifier of the category of lead pack (optional)
Type PackType Type of lead pack

Possible Options:
                            Not_Set
                            Standard
                            Aged
ResellerUID Int64 Unique identifier of the reseller assigned to the lead pack
ClientUID Int64 Unique identifier of the client to provide pricing for (optional)

Response Properties

Name Type Description
Description String The description of the lead pack
LeadPackUID Int64 The unique identifier of the lead pack (set as -1 for new)
LeadTypeUID Int64 The unique identifier of the lead type assigned
LeadTypeName String The name of the lead type (return only)
ExpDate DateTime The expiration date of this lead pack
Qty Int32 The quantity of leads offered
Price Double The price for the quantity of leads
AccountUID Int64 The ID of the account this lead pack is assigned to (return only)
LeadCatUID Int64 The unique identifier of the lead category assigned
PackType PackType The type of lead pack

Possible Options:
                            Not_Set
                            Standard
                            Aged
PackCatUID Int64 The unique identifier for the category of this lead pack
StartDayRange Int32 Start number of days for order
EndDayRange Int32 End number of days for order
OrderMinimum Int32 The minimum quantity of leads that can be ordered against this lead pack
OrderMaximum Int32 The maximum quantity of leads that can be ordered against this lead pack
IncludeOverMax Boolean Include leads that have been already delivered to their max delivery setting
Criterias Array Array of criteria to apply when sending against this lead pack


GetLeadPackCats


Provides a list of all available categories for lead packs.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetLeadPackCats
Additional Information: https://api.leadexec.net/service.asmx?op=GetLeadPackCats

Request Parameters

Name Type Description
Key String API access key

Response Properties

Name Type Description
LeadPackCatUID Int64 The unique identifier of the lead pack category (set as -1 for new)
Name String The name of the lead pack category


UpdateLeadReportCache


Provides the ability to update the reporting cache for a lead.


Service URL

Method Location: https://api.leadexec.net/service.asmx/UpdateLeadReportCache
Additional Information: https://api.leadexec.net/service.asmx?op=UpdateLeadReportCache

Request Parameters

Name Type Description
key String API access key
leadUid Int64 Unique identifier of lead to update

Response Properties

No return properties available


GetStateList


Provides a list of US states.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetStateList
Additional Information: https://api.leadexec.net/service.asmx?op=GetStateList

Request Parameters

Name Type Description
Key String API access key

Response Properties

Name Type Description
StateUID Int64 The unique identifier for the US state
Name String The name of the US state
Abbr String The abbreviation of the US state


GetAgedLeadswCriteria


Provides the ability to scan for aged data based on criteria.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetAgedLeadswCriteria
Additional Information: https://api.leadexec.net/service.asmx?op=GetAgedLeadswCriteria

Request Parameters

Name Type Description
Key String API access key
ao AgedOptions Aged data pull options
ao.Customer Int64 The unique identifier of the client this option applies to
ao.CustomerAccount Int64 The unique identifier of the delivery account this option applies to
ao.LeadPrice Double Lead price to be applied
ao.StartDay Int32 Start day and time of the search (Pacific Time)
ao.EndDay Int32 End day and time of the search (Pacific Time)
ao.LeadCategory Int64 The unique identifier of the lead category (optional)
ao.LeadTypeUID Int64 The unique identifier of the lead type to search
ao.UseOverMax Boolean Should leads that have been delievered to their max setting show
criteria Array Criteria to apply to the search
criteria.ClientCriteriaUID Int64 The unique identifier for the criteria (set to -1 for new criteria)
criteria.LeadFieldUID Int64 The unique identifier for the lead field the criteria is assigned to (set to -1 for new field)
criteria.Type CriteriaType The type of criteria

Possible Options:
                            FieldValue
                            Expression
                            Function
criteria.Expression String The calculated or regular expression applied to this criteria
criteria.Operator CriteriaOperator The operation to be performed on the value of the lead

Possible Options:
                            Equal
                            NotEqual
                            Greater
                            Less
                            GreaterOrEqual
                            LessOrEqual
                            Between
                            In
                            NotIn
                            DateCompare
                            Distance_Compare
                            Contains
                            Doesnt_Contain
criteria.Value String The value the operation will apply to

Response Properties

No return properties available


AddEditDataPullInfo


Provides the ability to add or edit large data pull properties.


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddEditDataPullInfo
Additional Information: https://api.leadexec.net/service.asmx?op=AddEditDataPullInfo

Request Parameters

Name Type Description
Key String API access key
data DataPullType Data pull properties
data.DataPullUID Int64 The unique identifier for the data pull (set to -1 for new)
data.AccountUID Int64 The unique identifier for the account assigned
data.ClientUID Int64 The unique identifier of the client assigned
data.ClientAccountUID Int64 The unique identifier of the delivery account assigned
data.Leads String List of lead IDs separated by |
data.TotalPrice Double Total price of leads
data.Status Int32 Status of the data pull
data.CardTransUID Int64 The transaction ID for the credit card transaction

Response Properties

No return properties available


GetLeadTypes


Provides a list of all lead types avaialble.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetLeadTypes
Additional Information: https://api.leadexec.net/service.asmx?op=GetLeadTypes

Request Parameters

Name Type Description
Key String API access key
LeadTypeUID Int64 Unique identifier for the lead type requested (set to 0 for all lead types)

Response Properties

Name Type Description
LeadTypeUID Int64 The unique identifier for the lead type
AccountUID Int64 The unique identifier for the associated account
InQC Int32 (Obsolete)
Descriptor String The description of the lead type
Status Boolean (Obsolete)
DefaultDupSets String (Obsolete)
TypeUID Int32 The industry type for the lead type (see Industry Types for more information)


GetLeadFields


Provides a list of lead fields for the supplied lead type.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetLeadFields
Additional Information: https://api.leadexec.net/service.asmx?op=GetLeadFields

Request Parameters

Name Type Description
Key String API access key
LeadTypeUID Int64 Unique identifier for the lead type

Response Properties

Name Type Description
LeadFieldUID Int64 The unique identifier for the lead field (Supply -1 for new field)
LeadTypeUID Int64 The unique identifier for the lead type the field is associated with
Descriptor String The description of the field
FieldDataType DataType The data type of the field

Possible Options:
                            No_DataType
                            Int
                            Bigint
                            Bit
                            Money
                            Decimal
                            Float
                            DateTime
                            Varchar
Required Boolean Is the field required when receiving a lead
Status Boolean Is the field enabled (obsolete)
Computed Boolean Does the contain a calculated expression
ComputedExpr String Calculated expression of the field
Enumerated Boolean Does the field contain a list of enumerated values
Validation String Validation expression use to validate field value (see Validation Expressions for more information)
InvalidChars String Invalid character expression use to remove improper characters from field value (see Invalid Character Expressions for more information)
FmtError String Message to display when format is invalid (obsolete)
FormatString String Format to be applied to the field when displayed (see Format Expressions for more information)
isState Boolean Does this field contain the ID for a US State
FieldDescription String Long description of the field
ColSpan Int32 Column span when shown in detail views
Width Int32 Field width when shown in detail views
Height Int32 Field height when shown in detail views
SpecialBit LeadFieldSpecialBit Which system field should this field be used by the system as (see System Fields for more information)

Possible Options:
                            No_SpecialBit
                            FirstName
                            LastName
                            Email
                            PrimaryPhone
                            Address
                            City
                            State
                            Zip
                            MobilePhone
                            IPAddress
                            DirectTrackAffiliateID
                            DirectTrackCampaignID
                            ClientSendNotes
                            IndexDate
                            Address2
                            SubSource
                            ForceID
                            SubSourceCategory
                            SubCategory
                            StandardAddress
                            StandardCity
                            StandardState
                            StandardZip
                            Comments
                            Country
                            MobileCheck
                            ContactConsent
                            OrigFirstName
                            OrigLastName
                            OrigAddress
                            OrigCity
                            OrigState
                            OrigPostalCode
                            OrigCountry
                            OrigPhoneNumber
                            IPLat
                            IPLong
                            OrigIP
                            ConsentText
                            Status
                            LastAction
                            CurrentWorkflow
                            DateClosed
                            PipelineOneTimeFees
                            PipelineRecurringFees
FieldEnums Array Array of available enumerations for this field
Delete Boolean Should this field be deleted when saved


SearchForLead


Search for existing lead based on Email, Address, or Primary Phone.


Service URL

Method Location: https://api.leadexec.net/service.asmx/SearchForLead
Additional Information: https://api.leadexec.net/service.asmx?op=SearchForLead

Request Parameters

Name Type Description
Key String API access key
LID Int64 Unique identifier for the lead type
Email String Email to search (optional)
Address String Address to search (optional)
PrimaryPhone String Primary phone to search (optional)

Response Properties

Name Type Description
isValidPost Boolean Is the lead valid when received
ResponseType ResponseErrors The type of response send to lead source

Possible Options:
                            No_Error
                            System_ID_Missing
                            LeadType_ID_Missing
                            Vendor_ID_Missing
                            No_Account_Found
                            Outside_Criteria
                            Duplicate_Lead
                            Account_Disabled
                            Post_Over_Max
                            Data_Errors
ResponseDetails String The details of the response. Includes information about missing fields and other information
LeadIdentifier Int64 The unique identifier for this lead
VID Int64 The lead source's unique identifier submitted with this lead
AID Int64 The lead source campaign's unique identifier assigned to this lead
LID Int64 The lead type's unique identifier assigned to this lead
PendingQCReview Boolean Is the lead pending quality control review
Price Double The cost of the lead as reported to lead source


GetCustomList


Provides a single destribution list settings.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetCustomList
Additional Information: https://api.leadexec.net/service.asmx?op=GetCustomList

Request Parameters

Name Type Description
Key String API access key
ClientUID Int64 Unique identifier for the client (optional)
CustomListUID Int32 Unique identifier for the distribution list

Response Properties

Name Type Description
CustomListUID Int32 The unique identifier for the distribution list (set as -1 for new)
AccountUID Int64 Account distribution list is assigned to (return only)
LeadTypeUID Int64 The unique identifier for the lead type assigned
LeadFieldUID Int64 The unique identifier for the lead field assigned
Description String The name field
FieldName String The name of the lead field (return only)
DefaultClient Int64 The unique identifier for the catch-all client
ClientName String The name of the catch-all client (return only)
Assigned Int32 Number of clients currently assigned (return only)
Unassigned Int32 Number of unassigned items in list (return only)
Status Int32 Current status (see Distribution List Statuses for more information)
DependField Int64 The unique identifier for the lead field that should determine if the list matches the lead
Value String The value of the DependField that will be compared to the lead
LinkFieldText String Name of the DependField (return only)
Items Array Array of distribution list items


GetCustomLists


Provides a list of all distribution lists.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetCustomLists
Additional Information: https://api.leadexec.net/service.asmx?op=GetCustomLists

Request Parameters

Name Type Description
Key String API access key

Response Properties

Name Type Description
CustomListUID Int32 The unique identifier for the distribution list (set as -1 for new)
AccountUID Int64 Account distribution list is assigned to (return only)
LeadTypeUID Int64 The unique identifier for the lead type assigned
LeadFieldUID Int64 The unique identifier for the lead field assigned
Description String The name field
FieldName String The name of the lead field (return only)
DefaultClient Int64 The unique identifier for the catch-all client
ClientName String The name of the catch-all client (return only)
Assigned Int32 Number of clients currently assigned (return only)
Unassigned Int32 Number of unassigned items in list (return only)
Status Int32 Current status (see Distribution List Statuses for more information)
DependField Int64 The unique identifier for the lead field that should determine if the list matches the lead
Value String The value of the DependField that will be compared to the lead
LinkFieldText String Name of the DependField (return only)
Items Array Array of distribution list items


AddClearCustomItemAssignment


Provides the ability to add or remove an assignment from a distribution list item.


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddClearCustomItemAssignment
Additional Information: https://api.leadexec.net/service.asmx?op=AddClearCustomItemAssignment

Request Parameters

Name Type Description
Key String API access key
ClientUID Int64 Unique identifier for the client
CustomListUID Int32 Unique identifier for the distribution list
CustomItemUID Int64 Unique identifier for the distribution list item (set to -1 for new)
Clear Boolean Should the system remove an assignment if one exists

Response Properties

No return properties available


AddEditCustomListItem


Provides the ability to add or edit a distribution list item.


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddEditCustomListItem
Additional Information: https://api.leadexec.net/service.asmx?op=AddEditCustomListItem

Request Parameters

Name Type Description
Key String API access key
Item CustomListItem Distribution list item details

Response Properties

No return properties available


GetUSZipCodesforCounty


Provides all United States zip codes for the supplied county and state.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetUSZipCodesforCounty
Additional Information: https://api.leadexec.net/service.asmx?op=GetUSZipCodesforCounty

Request Parameters

Name Type Description
Key String API access key
County String County field
State String State field

Response Properties

No return properties available


GetUSZipCodesforFIPS


Provides all United States zip codes for the supplied federal information processing standard.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetUSZipCodesforFIPS
Additional Information: https://api.leadexec.net/service.asmx?op=GetUSZipCodesforFIPS

Request Parameters

Name Type Description
Key String API access key
FIPS String FIPS field

Response Properties

No return properties available


GetUSZipCodesfromRadius


Provides all United States zip codes within the mile radius of the zip code specified.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetUSZipCodesfromRadius
Additional Information: https://api.leadexec.net/service.asmx?op=GetUSZipCodesfromRadius

Request Parameters

Name Type Description
Key String API access key
ZipCode String Center zip code
Miles Double Radius length in miles
InState Boolean Should the search keep within the same state as the center zip code

Response Properties

No return properties available


GetUSZipCodesforState


Provides a list of all United States zip codes within the specified state.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetUSZipCodesforState
Additional Information: https://api.leadexec.net/service.asmx?op=GetUSZipCodesforState

Request Parameters

Name Type Description
Key String API access key
State String State field

Response Properties

No return properties available


GetSiteVisitInformationForLead


Provides the site visit information for analytics for a lead ID


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetSiteVisitInformationForLead
Additional Information: https://api.leadexec.net/service.asmx?op=GetSiteVisitInformationForLead

Request Parameters

Name Type Description
key String API access key
leadUid Int64 Unique identifier for lead

Response Properties

Name Type Description
TrackingUID Int64 Unique identifier of the tracking setting
VisitUID String Unique identifier of the visit
EnterDate DateTime Date and time the user entered the site
ExitDate DateTime Date and time the user exited the site
UserAgent String User agent of the user as reported by the browser
IP String User host address of the user
URL String URL called when entering the site
Host String Host of the site
EnterPage String Page the user entered the site on
ExitPage String Last page viewed by the user
Referrer String Site that referred the user to the site
ReferrerHost String Host portion of the referrer URL
SearchEngine String Friendly name of the search engine
SearchTerm String Search term applied to the search engine
Browser String Name of browser
OS String Name of operating system
PageViews Int32 How many pages viewed on the site
FirstVisit Boolean Is this the users first visit to the site


GetSiteVisitInformationForVisitId


Provides the site visit information for analytics for a visit ID


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetSiteVisitInformationForVisitId
Additional Information: https://api.leadexec.net/service.asmx?op=GetSiteVisitInformationForVisitId

Request Parameters

Name Type Description
key String API access key
visitId String Unique identifier for visit

Response Properties

Name Type Description
TrackingUID Int64 Unique identifier of the tracking setting
VisitUID String Unique identifier of the visit
EnterDate DateTime Date and time the user entered the site
ExitDate DateTime Date and time the user exited the site
UserAgent String User agent of the user as reported by the browser
IP String User host address of the user
URL String URL called when entering the site
Host String Host of the site
EnterPage String Page the user entered the site on
ExitPage String Last page viewed by the user
Referrer String Site that referred the user to the site
ReferrerHost String Host portion of the referrer URL
SearchEngine String Friendly name of the search engine
SearchTerm String Search term applied to the search engine
Browser String Name of browser
OS String Name of operating system
PageViews Int32 How many pages viewed on the site
FirstVisit Boolean Is this the users first visit to the site


ResendLead


Reprocess lead delivery to clients


Service URL

Method Location: https://api.leadexec.net/service.asmx/ResendLead
Additional Information: https://api.leadexec.net/service.asmx?op=ResendLead

Request Parameters

Name Type Description
key String API access key
leadSendUid Int64 Identifier of lead send

Response Properties

No return properties available


SetDefaultFieldMappings


Scans the lead type assigned to a delivery and creates the mappings based on the fields included in the lead type.


Service URL

Method Location: https://api.leadexec.net/service.asmx/SetDefaultFieldMappings
Additional Information: https://api.leadexec.net/service.asmx?op=SetDefaultFieldMappings

Request Parameters

Name Type Description
Key String API access key
DeliveryUID Int64 Unique identifier of the delivery method to modify

Response Properties

No return properties available


ProcessClientDelivery


Process the delivery method attached to the delivery account.


Service URL

Method Location: https://api.leadexec.net/service.asmx/ProcessClientDelivery
Additional Information: https://api.leadexec.net/service.asmx?op=ProcessClientDelivery

Request Parameters

Name Type Description
Key String API access key
LeadUID Int64 Unique identifier of the lead to send
ClientUID Int64 Unique identifier of the client to send to
ClientAccountUID Int64 Unique identifier of the delivery account to send to
ClientOrderUID Int64 Unique identifier of the client order the send should be assigned to
Notes String Notes to include on the send

Response Properties

Name Type Description
isValid Boolean Did the delivery result in a valid response
Status String The status of the delivery
Response String Actual response returned by the delivery attempt


ConfirmSale


Used to set that the send has been confirmed by the client.


Service URL

Method Location: https://api.leadexec.net/service.asmx/ConfirmSale
Additional Information: https://api.leadexec.net/service.asmx?op=ConfirmSale

Request Parameters

Name Type Description
Key String API access key
LeadUID Int64 Unique identifier of the lead
ClientUID Int64 Unique identifier of the client

Response Properties

No return properties available


AddEditClient


Provides the ability to create or edit clients. This method returns the ID of the client being added or edited. Be sure to use this ID when adding field data, delivery accounts, and/or delivery methods

When creating a new client be sure to set ClientUID to -1. This tells the system you wish to create a new client and will automatically update the fields with the proper client ID once the client has been created.


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddEditClient
Additional Information: https://api.leadexec.net/service.asmx?op=AddEditClient

Request Parameters

Name Type Description
Key String API access key
Client ClientItemType Information on the client
Client.ClientUID Int64 The unique identifier of the client (set to -1 for new)
Client.DateAdded DateTime The date the client was added (Pacific Time)
Client.Status ClientStatus The status of the client

Possible Options:
                            New
                            Pending
                            Working
                            Waiting
                            Dead
                            Inactive
                            Active
                            Late
                            Suspended
                            Closed
Client.InternalUID Int64 (obsolete)
Client.UserUID Int64 The unique identifier of the user assigned
Client.TimeOffset Int32 The amount of hours to offset based on time zone (see Time Zone Names for more information)
Client.Image Array (obsolete)
Client.Notes String Notes for the client
Client.IsLocked Boolean (Obsolete)
Client.LockedBy Int64 (Obsolete)
Client.DateLocked DateTime (Obsolete)
Client.LockedReason String (Obsolete)
Client.OutLookUID String (Obsolete)
Client.TimeZoneName String The name of the time zone assigned (see Time Zone Names for more information)
Client.ResellerUID Int64 The unique identifier of the reseller assigned to this client (set to -1 for no value)
Client.GroupUID Int64 The unique identifier of the client group this client is assigned to (set to 0 for no value)
Client.Username String Username for web portal access (check if username is unique before saving)
Client.Password String Password for web portal access
Client.OverrideReassign Boolean Allow client to reassign to all other clients
FieldData Array Array of fields to store on the client (see Client Field IDs for a list of field IDs).
FieldData.ClientFieldUID Int64 The unique identifier for the client field
FieldData.Descriptor String Descriptor of the field
FieldData.DataType DataType The data type assigned to the field

Possible Options:
                            No_DataType
                            Int
                            Bigint
                            Bit
                            Money
                            Decimal
                            Float
                            DateTime
                            Varchar
FieldData.Required Boolean Is the field required
FieldData.Status Boolean Is the field enabled (obsolete)
FieldData.Computed Boolean Does the field contain a calculated value
FieldData.ComputedExpr String Calculation expression for calculated values
FieldData.Enumerated Boolean Does the field contain a list of enumerated values
FieldData.Enums Array Array of valid enumerations
FieldData.Validation String Validation expression to validate incoming values
FieldData.InvalidChars String Invalid character expression for removing invalid characters from value
FieldData.FormatError String Message to be displayed when value contains an error
FieldData.FormatString String Format string to be applied when displayed
FieldData.SpecialBit ClientFieldSpecialBit The system field assigned to this field

Possible Options:
                            NoSpecialBit
                            Company
                            FirstName
                            LastName
                            Email
                            PrimaryPhone
                            PrimaryPhoneExt
                            AlternatePhone
                            Address
                            City
                            State
                            Zip
                            AlternatePhoneExt
                            FaxNumber
                            Comments
                            JobTitle
                            WebSite
                            MobilePhone
FieldData.isState Boolean Does this field contain a US state UID
FieldData.FieldValue String The value of the field
FieldData.PastValues Array Array of past values for this field

Response Properties

No return properties available


GetClientGroups


Provides a list of client groups


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientGroups
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientGroups

Request Parameters

Name Type Description
Key String API access key

Response Properties

Name Type Description
ClientGroupUID Int64 The unique identifier for the client group
Description String The description that is displayed for the client group
DisplayOrder Int32 The order this group displays in lists
ClientCount Int32 The number of clients currently assigned to this group


GetClientData


Provides an array of client fields for the requested client. This also includes any custom fields for the client.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientData
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientData

Request Parameters

Name Type Description
Key String API access key
ClientUID Int64 Unique identifier for the client

Response Properties

Name Type Description
ClientFieldUID Int64 The unique identifier for the client field
Descriptor String Descriptor of the field
DataType DataType The data type assigned to the field

Possible Options:
                            No_DataType
                            Int
                            Bigint
                            Bit
                            Money
                            Decimal
                            Float
                            DateTime
                            Varchar
Required Boolean Is the field required
Status Boolean Is the field enabled (obsolete)
Computed Boolean Does the field contain a calculated value
ComputedExpr String Calculation expression for calculated values
Enumerated Boolean Does the field contain a list of enumerated values
Enums Array Array of valid enumerations
Validation String Validation expression to validate incoming values
InvalidChars String Invalid character expression for removing invalid characters from value
FormatError String Message to be displayed when value contains an error
FormatString String Format string to be applied when displayed
SpecialBit ClientFieldSpecialBit The system field assigned to this field

Possible Options:
                            NoSpecialBit
                            Company
                            FirstName
                            LastName
                            Email
                            PrimaryPhone
                            PrimaryPhoneExt
                            AlternatePhone
                            Address
                            City
                            State
                            Zip
                            AlternatePhoneExt
                            FaxNumber
                            Comments
                            JobTitle
                            WebSite
                            MobilePhone
isState Boolean Does this field contain a US state UID
FieldValue String The value of the field
PastValues Array Array of past values for this field


AddEditClientGroup


Provides the ability to add or edit a client group.


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddEditClientGroup
Additional Information: https://api.leadexec.net/service.asmx?op=AddEditClientGroup

Request Parameters

Name Type Description
Key String API access key
Group ClientGroupType Group details
Group.ClientGroupUID Int64 The unique identifier for the client group
Group.Description String The description that is displayed for the client group
Group.DisplayOrder Int32 The order this group displays in lists
Group.ClientCount Int32 The number of clients currently assigned to this group

Response Properties

No return properties available


GetClientsForSend


Provides a list of available lead buyers based on criteria and order information (Automated clients only).


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientsForSend
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientsForSend

Request Parameters

Name Type Description
Key String API access key
LeadUID Int64 Unique identifier for the lead

Response Properties

Name Type Description
ClientUID Int64 The unique identifier for the client assigned to the send
ClientName String The name of the client assigned
ContactFirstName String First name field
ContactLastName String Last name field
Address String Address field
Address2 String Address2 field
City String City field
State String State field
Country String Country field
PostalCode String Postal Code field
PhoneNumber String Phone number field
Email String Email field
Notes String Notes field
DateSent DateTime attribute
IsValid Boolean Was the delivery valid
Response String The response received during delivery
Price Double The price assigned to the delivery


GetClientsforCriteria


Provides a list of available lead buyers that match the criteria submitted. This method accepts only HTTP POST/GET protocols. Your POST should include name value pairs that include the field name and value you want to scan.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientsforCriteria
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientsforCriteria

Request Parameters

Name Type Description
key String API access key
lid Int64 Unique identifier for the lead type being scanned

Response Properties

Name Type Description
ClientUID Int64 Unique identifier for the client
ClientName String Name field
ContactFirstName String Contact first name field
ContactLastName String Contact last name field
Address String Address field
Address2 String Address2 field
City String City field
State String State field
Country String Country field
PostalCode String Postal code field
PhoneNumber String Phone number field
Email String email field
Price Double Delivery account price
Website String Website field


GetClientsforCriteriaAdvanced


Provides a list of available lead buyers that match the criteria submitted.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientsforCriteriaAdvanced
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientsforCriteriaAdvanced

Request Parameters

Name Type Description
Key String API access key
LeadTypeUID Int64 Unique identifier of the lead type being scanned
Criteria Array Array of criteria items to apply to the scan
Criteria.Name String Name of the field
Criteria.Value String Value of the field

Response Properties

Name Type Description
ClientUID Int64 Unique identifier for the client
ClientName String Name field
ContactFirstName String Contact first name field
ContactLastName String Contact last name field
Address String Address field
Address2 String Address2 field
City String City field
State String State field
Country String Country field
PostalCode String Postal code field
PhoneNumber String Phone number field
Email String email field
Price Double Delivery account price
Website String Website field


AddEditClientAccount


Provides the ability to add or edit client delivery accounts


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddEditClientAccount
Additional Information: https://api.leadexec.net/service.asmx?op=AddEditClientAccount

Request Parameters

Name Type Description
Key String API access key
account ClientAccountType Account details
account.ClientAccountUID Int64 The unique identifier for the delivery account (set to -1 for new delivery account)
account.ClientUID Int64 The unique identifier for the client that this account is to be assigned to
account.DeliveryUID Int64 The unique identifier of the delivery that this account will use
account.Price Double The price for each lead that is sent to this account
account.HourMax Int32 The maximum amount of leads to be delivered (automatically) within the current hour (set to -1 for no limit)
account.DayMax Int32 The maximum amount of leads to be delivered (automatically) within the current day (set to -1 for no limit)
account.MonthMax Int32 The maximum amount of leads to be delivered (automatically) within the current month (set to -1 for no limit)
account.useOrder Boolean Should this delivery account use the order system
account.Status Int32 The status of the delivery account (see Delivery Account Statuses for more information)
account.DeliveryDelay Int32 The amount of seconds to delay the delivery when this delivery account is selected (set to 0 for no delay)
account.Description String The description of this delivery account
account.RedirectURL String The redirect URL to be supplied when this delivery takes place
account.AutomationEnabled Boolean Is automation enabled for this delivery account
account.AccountType Int32 The delivery account type for this delivery account (see Delivery Account Types for more information)
account.AgentName String The name of the agent to be returned during live call transfers
account.AgentPhone String The phone number of the agent to be returned during live call transfers
account.Criteria Array Array of criteria associated with this delivery account (for more information on critera value types, visit Delivery Account Criteria Types)
account.DeliveryDetails DeliveryType Primary delivery details for this delivery account

Response Properties

No return properties available


AddEditClientOrder


Provides the ability to add or edit client orders


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddEditClientOrder
Additional Information: https://api.leadexec.net/service.asmx?op=AddEditClientOrder

Request Parameters

Name Type Description
Key String API access key
order ClientOrderType Order details
order.ClientOrderUID Int64 The unique identifier for the client order (set to -1 for new)
order.ClientUID Int64 The unique identifier for the client this order applies to
order.StartDate DateTime The date and time the order starts (Pacific Time)
order.EndDate DateTime The date and time the order stops (Pacific Time)
order.Qty Int32 The sum of the quantity of leads within all items applied to this order (leave as 0 when creating)
order.Sent Int32 The quantity of leads sent on this order (return only)
order.Status OrderStatus The current status of the order

Possible Options:
                            Closed
                            Open
                            OnHold
order.Renewal OrderRenewal The renewal option set for the order

Possible Options:
                            No_Renewal
                            On_End_Date
                            On_Qty_Fill
order.AutoCharge Boolean Should the order be auto charged when renewed
order.Items Array Array of order items assigned to the order

Response Properties

No return properties available


RedirectStatusNotify


Provides the ability to notify LeadExec that the user was redirected properly.


Service URL

Method Location: https://api.leadexec.net/service.asmx/RedirectStatusNotify
Additional Information: https://api.leadexec.net/service.asmx?op=RedirectStatusNotify

Request Parameters

Name Type Description
Key String API access key
LeadUID Int64 Unique identifier of the lead
Redirect String URL provided to be redirected to
isValid Boolean Was the redirect completed
Response String Response notes to store on send

Response Properties

No return properties available


AddPayment


Provides the ability to add or edit a payment for a client


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddPayment
Additional Information: https://api.leadexec.net/service.asmx?op=AddPayment

Request Parameters

Name Type Description
Key String API access key
ClientUID Int64 Unique identifier for the client
ClientOrderUID Int64 Unique identifier for the client order
CardTransUID Int64 Card transaction ID
Amount Double The amount of the payment
IsValid Boolean Was the payment accepted or declined
Response String Response from payment merchent

Response Properties

No return properties available


GetClientAccounts


Provides a list of delivery accounts for a client.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientAccounts
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientAccounts

Request Parameters

Name Type Description
Key String API access key
ClientUID Int64 Unique identifier for the client

Response Properties

Name Type Description
ClientAccountUID Int64 The unique identifier for the delivery account (set to -1 for new delivery account)
ClientUID Int64 The unique identifier for the client that this account is to be assigned to
DeliveryUID Int64 The unique identifier of the delivery that this account will use
Price Double The price for each lead that is sent to this account
HourMax Int32 The maximum amount of leads to be delivered (automatically) within the current hour (set to -1 for no limit)
DayMax Int32 The maximum amount of leads to be delivered (automatically) within the current day (set to -1 for no limit)
MonthMax Int32 The maximum amount of leads to be delivered (automatically) within the current month (set to -1 for no limit)
useOrder Boolean Should this delivery account use the order system
Status Int32 The status of the delivery account (see Delivery Account Statuses for more information)
DeliveryDelay Int32 The amount of seconds to delay the delivery when this delivery account is selected (set to 0 for no delay)
Description String The description of this delivery account
RedirectURL String The redirect URL to be supplied when this delivery takes place
AutomationEnabled Boolean Is automation enabled for this delivery account
AccountType Int32 The delivery account type for this delivery account (see Delivery Account Types for more information)
AgentName String The name of the agent to be returned during live call transfers
AgentPhone String The phone number of the agent to be returned during live call transfers
Criteria Array Array of criteria associated with this delivery account (for more information on critera value types, visit Delivery Account Criteria Types)
DeliveryDetails DeliveryType Primary delivery details for this delivery account


GetClientAccount


Retrieve a single delivery account for a client.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientAccount
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientAccount

Request Parameters

Name Type Description
Key String API access key
ClientUID Int64 Unique identifier for the client
AccountUID Int64 Unique identifier for the delivery account

Response Properties

Name Type Description
ClientAccountUID Int64 The unique identifier for the delivery account (set to -1 for new delivery account)
ClientUID Int64 The unique identifier for the client that this account is to be assigned to
DeliveryUID Int64 The unique identifier of the delivery that this account will use
Price Double The price for each lead that is sent to this account
HourMax Int32 The maximum amount of leads to be delivered (automatically) within the current hour (set to -1 for no limit)
DayMax Int32 The maximum amount of leads to be delivered (automatically) within the current day (set to -1 for no limit)
MonthMax Int32 The maximum amount of leads to be delivered (automatically) within the current month (set to -1 for no limit)
useOrder Boolean Should this delivery account use the order system
Status Int32 The status of the delivery account (see Delivery Account Statuses for more information)
DeliveryDelay Int32 The amount of seconds to delay the delivery when this delivery account is selected (set to 0 for no delay)
Description String The description of this delivery account
RedirectURL String The redirect URL to be supplied when this delivery takes place
AutomationEnabled Boolean Is automation enabled for this delivery account
AccountType Int32 The delivery account type for this delivery account (see Delivery Account Types for more information)
AgentName String The name of the agent to be returned during live call transfers
AgentPhone String The phone number of the agent to be returned during live call transfers
Criteria Array Array of criteria associated with this delivery account (for more information on critera value types, visit Delivery Account Criteria Types)
DeliveryDetails DeliveryType Primary delivery details for this delivery account


AddEditClientDelivery


Provides the ability to add or edit a client delivery method


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddEditClientDelivery
Additional Information: https://api.leadexec.net/service.asmx?op=AddEditClientDelivery

Request Parameters

Name Type Description
Key String API access key
delivery DeliveryType Delivery details
delivery.ClientDeliveryUID Int64 The unique identifier for the delivery method (set to -1 for new delivery method)
delivery.ClientUID Int64 The unique identifier for the client the delivery is assigned to
delivery.Type Int32 The type of delivery (see Delivery Types for more information
delivery.Name String The name of the delivery method
delivery.Status Boolean Is the delivery enabled
delivery.DateAdded DateTime The date the delivery method was added (Pacific Time)
delivery.inTesting Boolean Is the delivery method currently in testing
delivery.LeadTypeUID Int64 The unique identifier for the lead type this delivery method is assigned to
delivery.XML String The XML schema to be applied if XML delivery is used.
delivery.EmailTemplate String The XML schema to be applied if XML delivery is used.
delivery.EmailSubject String The subject to be applied if email delivery is used.
delivery.FTPUser String The username to be applied to FTP delivery
delivery.FTPPassword String The password to be applied to FTP delivery
delivery.FTPPath String The file path to append to the file during FTP delivery
delivery.EmailAddress String The email address to send to during this delivery
delivery.useRegEx Boolean Use regular expressions when searching response
delivery.ResponseSearch String The search string applied when scanning response for a valid response
delivery.DeliveryAddress String The URL that this delivery method will deliver to (if using a POST/GET delivery method)
delivery.SMTPServer String The server address of the SMTP server to use to send an email delivery (optional)
delivery.SMTPAuth Boolean Does the SMTP server require authentication
delivery.SMTPUsername String The username of the SMTP server
delivery.SMTPPassword String The password of the SMTP server
delivery.fAddress String The address to display in the from address when sending email delivery or notifications
delivery.tAddress String The address to send to when sending email delivery or notifications (separate using a comma)
delivery.EmailNotify Boolean Should the system send a notification email
delivery.NotifyCC String The addresses to include as CC when sending an email delivery (separate using a comma)
delivery.NotifyBCC String The addresses to include as BCC when sending an email delivery (separate using a comma)
delivery.NotifyEmail String The email address to send the notification email to
delivery.LeadCatUID Int64 The lead category assigned to this delivery method (set as 0 for unassigned)
delivery.ClientEmail String The email body to be sent back to the lead when this delivery takes place (set to blank for no email)
delivery.FieldSettings Array The field mappings to be applied to this delivery
delivery.DeliveryDays Array The allowed days and times for this delivery method, see Delivery Days for more information

Response Properties

No return properties available


ClientLogin


Provides the ability to validate a user's username and password combination.


Service URL

Method Location: https://api.leadexec.net/service.asmx/ClientLogin
Additional Information: https://api.leadexec.net/service.asmx?op=ClientLogin

Request Parameters

Name Type Description
Key String API access key
Username String Client's username
Password String Client's password

Response Properties

Name Type Description
ClientUID Int64 The unique identifier of the client (set to -1 for new)
DateAdded DateTime The date the client was added (Pacific Time)
Status ClientStatus The status of the client

Possible Options:
                            New
                            Pending
                            Working
                            Waiting
                            Dead
                            Inactive
                            Active
                            Late
                            Suspended
                            Closed
InternalUID Int64 (obsolete)
UserUID Int64 The unique identifier of the user assigned
TimeOffset Int32 The amount of hours to offset based on time zone (see Time Zone Names for more information)
Image Array (obsolete)
Notes String Notes for the client
IsLocked Boolean (Obsolete)
LockedBy Int64 (Obsolete)
DateLocked DateTime (Obsolete)
LockedReason String (Obsolete)
OutLookUID String (Obsolete)
TimeZoneName String The name of the time zone assigned (see Time Zone Names for more information)
ResellerUID Int64 The unique identifier of the reseller assigned to this client (set to -1 for no value)
GroupUID Int64 The unique identifier of the client group this client is assigned to (set to 0 for no value)
Username String Username for web portal access (check if username is unique before saving)
Password String Password for web portal access
OverrideReassign Boolean Allow client to reassign to all other clients


isUsernameUnique


Verify that a new username is unique to the system and not already in use.


Service URL

Method Location: https://api.leadexec.net/service.asmx/isUsernameUnique
Additional Information: https://api.leadexec.net/service.asmx?op=isUsernameUnique

Request Parameters

Name Type Description
Key String API access key
Username String New username

Response Properties

No return properties available


RunClientCard


Provides the ability to run a credit card for lead purchase.


Service URL

Method Location: https://api.leadexec.net/service.asmx/RunClientCard
Additional Information: https://api.leadexec.net/service.asmx?op=RunClientCard

Request Parameters

Name Type Description
Key String API access key
ClientUID Int64 Unique identifier
CardNumber String Credit card number
ExpDate String Credit card expiration date
CVN String Credit card security code
Address String Billing address
City String Billing city
State String Billing state
Zip String Billing zip code
CardType String Card type (ex: VISA, MASTERCARD, DISCOVER, etc.)
Amount Double The amount of the transaction

Response Properties

Name Type Description
ClientTranUID Int64 Transaction unique identifier
ClientUID Int64 The unique identifier of the client that is assigned to the card
IsValid Boolean Was the charge accepted or declined
Response String Response from credit card processor
CardNumber String Card number for processed card
ExpDate String Expiration date of the processed card
CVN String Security code of the processed card (removed)
Amount Double Amount of the transaction
DateRan DateTime Date (Pacific Time) that the transaction was ran


AddCreditCard


Provides the ability to add a new credit card to a client.


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddCreditCard
Additional Information: https://api.leadexec.net/service.asmx?op=AddCreditCard

Request Parameters

Name Type Description
Key String API access key
card CreditCardType Card details
card.ClientUID Int64 The unique identifier of the client that is assigned to the card
card.CardNumber String The card number
card.ExpMonth String The expiration month (2 digits)
card.ExpYear String The expiration year (4 digits)
card.Company String The company name associated with the card
card.FirstName String The first name associated with the card
card.LastName String The last name associated with the card
card.NameOnCard String The full name as it appears on the card
card.Bill_Address String The billing address associated with the card
card.Bill_City String THe billing city associated with the card
card.Bill_State String The billing state associated with the card
card.Bill_Zip String The billing postal / zip code associated with the card
card.CardType String The type of card (example: VISA, MASTERCARD, DISCOVER, ETC)
card.Status Int32 The status of the card (0 = Disabled | 1 = Enabled)
card.IsPrimary Boolean Is this card to be used as the primary method of payment

Response Properties

No return properties available


LogClientSend


Provides the ability to log in the system that a lead was sent to a client.

Note: You can use methods like GetClientsForLead to receive the values needed for this method.


Service URL

Method Location: https://api.leadexec.net/service.asmx/LogClientSend
Additional Information: https://api.leadexec.net/service.asmx?op=LogClientSend

Request Parameters

Name Type Description
Key String API access key
ClientUID Int64 Unique identifier for the client
LeadUID Int64 Unique identifier for the lead
DeliveryUID Int64 Unique identifier for the delivery method used
PostString String Request string or email template sent
Response String Response from the receiving system
ClientOrderUID Int64 Unique identifier for the order assigned
ClientOrderItemUID Int64 Unique identifier for order item assigned
ClientAccountUID Int64 Unique identifier for the delivery account

Response Properties

No return properties available


GetAllCriteriaAccounts


Provides a list of all delivery accounts with criteria matching the options supplied.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetAllCriteriaAccounts
Additional Information: https://api.leadexec.net/service.asmx?op=GetAllCriteriaAccounts

Request Parameters

Name Type Description
Key String API access key
LeadTypeUID Int64 Unique identifier for the lead type
LeadFieldUID Int64 Unique identifier for the lead field
Value String Value of the criteria on the delivery account

Response Properties

Name Type Description
ClientAccountUID Int64 The unique identifier for the delivery account (set to -1 for new delivery account)
ClientUID Int64 The unique identifier for the client that this account is to be assigned to
DeliveryUID Int64 The unique identifier of the delivery that this account will use
Price Double The price for each lead that is sent to this account
HourMax Int32 The maximum amount of leads to be delivered (automatically) within the current hour (set to -1 for no limit)
DayMax Int32 The maximum amount of leads to be delivered (automatically) within the current day (set to -1 for no limit)
MonthMax Int32 The maximum amount of leads to be delivered (automatically) within the current month (set to -1 for no limit)
useOrder Boolean Should this delivery account use the order system
Status Int32 The status of the delivery account (see Delivery Account Statuses for more information)
DeliveryDelay Int32 The amount of seconds to delay the delivery when this delivery account is selected (set to 0 for no delay)
Description String The description of this delivery account
RedirectURL String The redirect URL to be supplied when this delivery takes place
AutomationEnabled Boolean Is automation enabled for this delivery account
AccountType Int32 The delivery account type for this delivery account (see Delivery Account Types for more information)
AgentName String The name of the agent to be returned during live call transfers
AgentPhone String The phone number of the agent to be returned during live call transfers
Criteria Array Array of criteria associated with this delivery account (for more information on critera value types, visit Delivery Account Criteria Types)
DeliveryDetails DeliveryType Primary delivery details for this delivery account


GetClientList


Provides a list of all clients.


Service URL

Method Location: https://api.leadexec.net/service.asmx/GetClientList
Additional Information: https://api.leadexec.net/service.asmx?op=GetClientList

Request Parameters

Name Type Description
Key String API access key

Response Properties

Name Type Description
ClientUID Int64 The unique identifier for the client
AccountUID Int64 The unique identifier for the account assigned
DateAdded DateTime The date the client was added (Pacific Time)
Status Int32 The status of the client (see Client Statuses for more information)
InternalUID Int64 (Obsolete)
UserUID Int64 The unique identifier for the user that created the client
TimeOffset Int32 The number of hours to offset based on timezone
Image Array (Obsolete)
Notes String The notes field
IsLocked Boolean (Obsolete)
LockedBy Int64 (Obsolete)
DateLocked DateTime (Obsolete)
LockedReason String (Obsolete)
OutLookUID String (Obsolete)
TimeZoneName String The timezone field
ResellerUID Int64 The reseller assigned
GroupUID Int64 The unique identifier of the client group assigned
AutomationType ClientAutomationType The default type of delivery account automation

Possible Options:
                            Price
                            Priority
                            RoundRobin
Priority Int32 The priority of the client during distribution
DeliveryGroupUID Int64 The unique identifier for the delivery group assigned
Username String The username for access to the webportal
Password String The password for access to the webportal
ShowLeadGrade Boolean Should the lead grade be shown in the webportal
ShowLeadSource Boolean Should the lead source be shown in the webportal
ShowCampaign Boolean Should the campaign be shown in the webportal
AllowCalls Boolean Should the webportal allow the user to place calls
AllowReassign Boolean Should the webportal allow the user to reassign a lead
UserAssigned Int64 The unique identifier of the user this client is assigned to
UseDeliveryTiers Boolean Should the distribution system allow multiple delivery accounts to be delivered to
OverrideReassign Boolean Allow client to reassign to all other clients


VendorUserNameUnique


Provides the ability to verify that a new username is unique and not already in use.


Service URL

Method Location: https://api.leadexec.net/service.asmx/VendorUserNameUnique
Additional Information: https://api.leadexec.net/service.asmx?op=VendorUserNameUnique

Request Parameters

Name Type Description
Key String API access key
UserName String Lead source username
VendorUID Int64 Unique identifier of the lead source to exclude when searching (optional)

Response Properties

No return properties available


AddEditVendor


Provides the ability to add or edit a lead source's information.


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddEditVendor
Additional Information: https://api.leadexec.net/service.asmx?op=AddEditVendor

Request Parameters

Name Type Description
Key String API access key
vInfo VendorInfoType Lead source information details
vInfo.LPVendorUID Int64 The identifier for the lead source
vInfo.Name String Name field
vInfo.Address String Address field
vInfo.Address2 String Second address field
vInfo.City String City field
vInfo.State Int64 State field
vInfo.Zip String Zip field
vInfo.Phone String Phone field
vInfo.Fax String Fax field
vInfo.Email String Email field
vInfo.ReturnString String (Obsolete)
vInfo.ReturnPostURL String (Obsolete)
vInfo.SystemVendor Boolean (Obsolete)
vInfo.Status Int32 Status of the lead source (see Lead Source Statuses for more information)
vInfo.UserName String The username for web portal access
vInfo.Password String The password for web portal access
vInfo.AdminUID Int64 (Obsolete)
vInfo.CherryAccountUID Int64 (Obsolete)
vInfo.AccountUID Int64 The unique identifier for the account assigned
vInfo.ImageURL String (Obsolete)
vInfo.DefaultReturnDay Int32 The amount of days that the system will allow a lead to be returned

Response Properties

No return properties available


AddEditVendorAccount


Provides the ability to add or edit a lead source's campaign.


Service URL

Method Location: https://api.leadexec.net/service.asmx/AddEditVendorAccount
Additional Information: https://api.leadexec.net/service.asmx?op=AddEditVendorAccount

Request Parameters

Name Type Description
Key String API access key
aInfo VendorAccountType Campaign details
aInfo.VendorAccountUID Int64 The unique identifier for the lead source campaign
aInfo.AccountName String The name of the campaign
aInfo.AccountVendorUID Int64 The unique identifier for the lead source
aInfo.VendorUID Int64 The identifier for the lead source
aInfo.AccountUID Int64 The unique identifier for the account the lead source is assigned to
aInfo.LeadTypeUID Int64 The lead type that will be received from the campaign
aInfo.Status Int32 Status of the campaign (see Campaign Statuses for more information)
aInfo.MonthMax Int32 The maximum amount of leads that can be received in the current month (set as -1 for no limit)
aInfo.DayMax Int32 The maximum amount of leads that can be received in the current day (set as -1 for no limit)
aInfo.HourMax Int32 The maximum amount of leads that can be received in the current hour (set as -1 for no limit)
aInfo.Flagged Boolean (Obsolete)
aInfo.OrderSystem Boolean (Obsolete)
aInfo.ReturnDayCount Int32 The amount of days the system will allow a lead to be returned to the lead source
aInfo.ShowOnCherryPick Boolean (Obsolete)
aInfo.ClientDataVendor Boolean (Obsolete)
aInfo.countReturns Boolean Should the system count returns in quantity maxes
aInfo.LeadPrice Double The cost of the leads received on the campaign
aInfo.useQCBin Boolean Should the campaign direct leads into the quality control bin
aInfo.MaxSell Int32 The maximum amount of times a lead can be delivered out
aInfo.DupDayMax Int32 The amount of days to search to check for duplicates
aInfo.ExclusiveClientUID Int64 (Obsolete)
aInfo.LeadCatUID Int64 The unique identifier of the lead category the leads received are assigned to (optional)
aInfo.EmailVerify Boolean Should the system attempt a double opt-in
aInfo.AppendCityStateFromPostalCode Boolean Should the system automatically append city and state based on the postal code supplied
aInfo.Rules Array Array of criteria sets applied to this campaign for leads being received
aInfo.Validation ValidationSettings (Obsolete)

Response Properties

No return properties available


Back to Top