API Documentation
GetLeadTypeList
This method provides a list of available lead types for an account. It also includes the ID of the lead type to be used in other API calls.
Service URL
WCF Service:https://apps.leadexec.net/api/settings.svcRest Service:
https://apps.leadexec.net/api/settings/getleadtypelist
Request Parameters
| Name | Type | Description |
| token | String | Access token obtained from user's account after validating login. |
Response Properties
| Name | Type | Description |
| Id | Int64 | The ID of the lead type, this is used to reference this lead type in other API calls. |
| Name | String | Name of the lead type to be used in lists and display to the user. |
GetLeadType
This method provides details of the specified lead type as well as all fields associated with this lead type.
Service URL
WCF Service:https://apps.leadexec.net/api/settings.svcRest Service:
https://apps.leadexec.net/api/settings/getleadtype
Request Parameters
| Name | Type | Description |
| token | String | Access token obtained from user's account after validating login. |
| leadTypeId | Int64 | The identifier for the lead type. |
Response Properties
| Name | Type | Description |
| Name | String | Name of the lead type. |
| Id | Int64 | The ID of the lead type. |
| Fields | Array | An array of lead fields. |
| Field.Name | String | The name of the field. |
| Field.Id | Int64 | The ID of the field. |
| Field.DataType | FieldDataType | The type of data available for the field.
Possible Options: FieldContainer Int32 Int64 Boolean Double Decimal Float DateTime String PhoneNumber YesNo USState PostalCode |
| Field.Description | String | The description of what the field contains |
| Field.Required | Boolean | If the field is required |
| Field.FormatValidationRegEx | String | Used to check the format of the data to validate that is matches what is expected for the field |
| Field.ValidationRegEx | String | Used to remove any extra characters that are not allowed for this field |
| Field.Format | String | The format the data should display in when this field is displayed |
| Field.IsUSState | Boolean | Does this field contain an ID for a US state |
| Field.IsUSZipCode | Boolean | Does this field contain a US zip code for distance compare |
| Field.IsEnumerated | Boolean | Does this field have a list of enumerations |
| Field.AllowMultipleSelections | Boolean | Should multiple enumeration selections be allowed |
| Field.Enumerations | Array | An array of available enumerations |
| Field.Enumeration.Id | Int64 | The ID of the enumeration (this is the value located on the lead) |
| Field.Enumeration.Description | String | The description or caption of the enumeration to be displayed for this value |
| Field.ChildFields | Array | An array of fields that are contained within this field |
| Field.SystemField | SystemFieldType | System field is used to specify which field to use for certain key field types
Possible Options: None FirstName LastName EmailAddress PrimaryPhone Address City State Zip MobilePhone IPAddress DirectTrackAffiliateId DirectTrackCampaignId ClientSendNote 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 |
GetDataApiKey
This method provides the data and settings API key for an account.
Service URL
WCF Service:https://apps.leadexec.net/api/settings.svcRest Service:
https://apps.leadexec.net/api/settings/getdataapikey
Request Parameters
| Name | Type | Description |
| token | String | Access token obtained from user's account after validating login. |
Response Properties
| Name | Type | Description |
| KeyFound | Boolean | Was a key found for the account |
| ApiKey | String | Key for account |
GetLeadSourceList
This method provides a list of available lead sources for an account.
Service URL
WCF Service:https://apps.leadexec.net/api/leadsources.svcRest Service:
https://apps.leadexec.net/api/leadsources/getleadsourcelist
Request Parameters
| Name | Type | Description |
| token | String | Access token obtained from user's account after validating login. |
Response Properties
| Name | Type | Description |
| Name | String | Name of the lead source. |
| Id | Int64 | The ID of the lead type. |
| Address | String | Address of the lead source. |
| Address2 | String | Address (second line) of the lead source. |
| City | String | City of the lead source. |
| State | String | State of the lead source. |
| Zip | String | Zip code of the lead source. |
| Phone | String | Phone number of the lead source. |
| Fax | String | Fax number of the lead source. |
| String | Email of the lead source. | |
| Status | SourceStatus | Current status of the lead source.
Possible Options: Active Inactive OnHold Suspended Closed |
GetLeadSourceCampaigns
This method provides a list of available campaigns for the supplied lead source.
Service URL
WCF Service:https://apps.leadexec.net/api/leadsources.svcRest Service:
https://apps.leadexec.net/api/leadsources/getleadsourcecampaigns
Request Parameters
| Name | Type | Description |
| token | String | Access token obtained from user's account after validating login. |
| leadSourceId | Int64 | The ID of the lead source to pull campaigns. |
Response Properties
| Name | Type | Description |
| Name | String | Name of the campaign. |
| Id | Int64 | The ID of the campaign. |
| LeadTypeId | Int64 | The ID of the lead type the campaign is associated with. |
| Status | CampaignStatus | The current status of the campaign.
Possible Options: Closed Active Inactive Late OnHold Suspended |