Lead Receiver Documentation

The below documentation illustrates how to submit a lead into the LeadExec platform. For more information, please refer to the post documentation provided to you.

Note: The information provided below is designed to explain how to submit leads to our API. Additional data fields are not outlined below and you should refer to the documentation you received that will list out any additional fields that may be sent with the lead.


Create General Lead

This method creates a new lead in the system. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer query Required Your lead source identifier
lid integer query Required Your lead type identifier
aid integer query Your campaign identifier
password string query Required
(if provided)
Your API password provided in your documentation
(required if provided)
orderid string query Required
(if responding to PING)
The order ID from the PING request (only required if a ping request was first submitted)
response_type string url segement Required
(for async)
Your desired response type json or xml
returnurl string query For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com

Request

POST /processor/insert/general/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=&orderid=

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": ""
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
</PostResponse>

Async Request

POST /processor/insert/general/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=&returnurl=

Async Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create Redirect Lead

This method creates a new lead in the system, and either returns a redirect URL or forwards the request to a URL. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer query Required Your lead source identifier
lid integer query Required Your lead type identifier
aid integer query Your campaign identifier
password string query Required
(if provided)
Your API password provided in your documentation
(required if provided)
redirect_type string url segement Required The type of redirect to perform
(manualredirect or autoredirect)
response_type string url segement Your desired response type json or xml

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com

Request

POST /processor/insert/[redirect_type]/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": ""
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PostID>true</isValidPost>
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
</PostResponse>

Create Lead (include a list of who the lead was sent to)

This method creates a new lead in the system, and will return a list of names and prices of where the lead was sent. Note: This feature requires approval and will not function unless permission is granted. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer query Required Your lead source identifier
lid integer query Required Your lead type identifier
aid integer query Your campaign identifier
password string query Required
(if provided)
Your API password provided in your documentation
(required if provided)
response_type string url segement Required
(for async)
Your desired response type json or xml
returnurl string query For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com
Sends array of sends List of lead delivery sends array
Sends.ClientUID integer Identifier for the client the lead was sent to 9999999
Sends.ClientName string Name of the client the lead was sent to Demo Company
Sends.RedirectURL string Redirect url requested by the client https://example.com
Sends.Valid bool Was the send successful true
false
Sends.Price decimal Price of the lead that was paid by the client 25

Request

POST /processor/insert/returnsends/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": "",
    "Sends" : [
        {
            "ClientUID": 1234,
            "ClientName": "Demo Company",
            "RedirectURL": "",
            "Valid": true,
            "Price": 25
        },
        {
            "ClientUID": 5679,
            "ClientName": "Acme Company",
            "RedirectURL": "",
            "Valid": true,
            "Price": 25
        }]
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
  <Sends>
    <SendInfo>
      <ClientUID>1234</ClientUID>
      <ClientName>Demo Company</ClientName>
      <RedirectURL></RedirectURL>
      <Valid>true</Valid>
      <Price>25</Price>
    </SendInfo>
    <SendInfo>
      <ClientUID>Acme Company</ClientUID>
      <ClientName></ClientName>
      <RedirectURL></RedirectURL>
      <Valid>true</Valid>
      <Price>25</Price>
    </SendInfo>
  </Sends>
</PostResponse>

Async Request

POST /processor/insert/returnsends/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=&returnurl=

Async Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create Lead (include a list of who the lead should be transferred to)

This method creates a new lead in the system, and will return a list of names and numbers that the call should be transferred to. Note: This feature requires approval and will not function unless permission is granted. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer query Required Your lead source identifier
lid integer query Required Your lead type identifier
aid integer query Your campaign identifier
password string query Required
(if provided)
Your API password provided in your documentation
(required if provided)
response_type string url segement Your desired response type json or xml
returnurl string query For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com
ClientInfos array of agents List of agents array
ClientInfos.ClientUID integer Identifier for the client the lead was sent to 9999999
ClientInfos.ClientName string Name of the client the lead was sent to Demo Company
ClientInfos.AgentName string Name of the agent to transfer to John Smith
ClientInfos.AgentPhone bool Phone number of the agent to send to 7025551212

Request

POST /processor/insert/transfer/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": "",
    "ClientInfos" : [
        {
            "ClientUID": 1234,
            "ClientName": "Demo Company",
            "AgentName": "John Smith",
            "AgentPhone": "7025551212""
        },
        {
            "ClientUID": 5679,
            "ClientName": "Acme Company",
            "AgentName": "Bob McCarthy",
            "AgentPhone": "6025551212"
        }]
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
  <ClientInfos>
    <ClientInfo>
      <ClientUID>1234</ClientUID>
      <ClientName>Demo Company</ClientName>
      <AgentName>John Smith</AgentName>
      <AgentPhone>7025551212</AgentPhone>
    </ClientInfo>
    <ClientInfo>
      <ClientUID>5679</ClientUID>
      <ClientName>Acme Company</ClientName>
      <AgentName>Bob McCarthy</AgentName>
      <AgentPhone>6025551212</AgentPhone>
    </ClientInfo>
</PostResponse>

Async Request

POST /processor/insert/transfer/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=&returnurl=

Async Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create Call Lead

This method creates a new lead with call details in the system. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer query Required Your lead source identifier
lid integer query Required Your lead type identifier
aid integer query Your campaign identifier
password string query Required
(if provided)
Your API password provided in your documentation
(required if provided)
ivrnumber string query Required Phone number that the lead called
callduration integer query Required Call duration in seconds
callresult string query Result of call
calldate date/time query Date and time of call (expressed in Pacific Time)
response_type string url segement Your desired response type json or xml
returnurl string query For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com

Request

POST /processor/insert/transfer/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=&ivrnumber=&callduration=&callresult=&calldate=

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": "",
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
</PostResponse>

Async Request

POST /processor/insert/calldata/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=&ivrnumber=&callduration=&callresult=&calldate=&returnurl=

Async Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create General Lead   XML

This method creates a new lead in the system. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer attribute Required Your lead source identifier
lid integer attribute Required Your lead type identifier
aid integer attribute Your campaign identifier
password string attribute Required
(if provided)
Your API password provided in your documentation
(required if provided)
reference string attribute Reference value to store on the record for reporting purposes
response_type string url segement Required
(for async)
Your desired response type json or xml
returnurl string attribute For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com

Request

POST /processor/insert/general/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="">
<Lead reference="">
...
</Lead>
</Leads>

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": ""
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
</PostResponse>

Async Request

POST /processor/insert/general/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="" returnurl="">
<Lead reference="">
...
</Lead>
</Leads>

Async Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create Redirect Lead   XML

This method creates a new lead in the system, and either returns a redirect URL or forwards the request to a URL. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer attribute Required Your lead source identifier
lid integer attribute Required Your lead type identifier
aid integer attribute Your campaign identifier
password string attribute Required
(if provided)
Your API password provided in your documentation
(required if provided)
reference string attribute Reference value to store on the record for reporting purposes
redirect_type string url segement Required The type of redirect to perform
(manualredirect or autoredirect)
response_type string url segement Your desired response type json or xml

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com

Request

POST /processor/insert/[redirect_type]/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="">
<Lead reference="">
...
</Lead>
</Leads>

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": ""
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PostID>true</isValidPost>
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
</PostResponse>

Create Lead (include a list of who the lead was sent to)   XML

This method creates a new lead in the system, and will return a list of names and prices of where the lead was sent. Note: This feature requires approval and will not function unless permission is granted. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer attribute Required Your lead source identifier
lid integer attribute Required Your lead type identifier
aid integer attribute Your campaign identifier
password string attribute Required
(if provided)
Your API password provided in your documentation
(required if provided)
reference string attribute Reference value to store on the record for reporting purposes
response_type string url segement Required
(for async)
Your desired response type json or xml
returnurl string attribute For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com
Sends array of sends List of lead delivery sends array
Sends.ClientUID integer Identifier for the client the lead was sent to 9999999
Sends.ClientName string Name of the client the lead was sent to Demo Company
Sends.RedirectURL string Redirect url requested by the client https://example.com
Sends.Valid bool Was the send successful true
false
Sends.Price decimal Price of the lead that was paid by the client 25

Request

POST /processor/insert/returnsends/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="">
<Lead reference="">
...
</Lead>
</Leads>

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": "",
    "Sends" : [
        {
            "ClientUID": 1234,
            "ClientName": "Demo Company",
            "RedirectURL": "",
            "Valid": true,
            "Price": 25
        },
        {
            "ClientUID": 5679,
            "ClientName": "Acme Company",
            "RedirectURL": "",
            "Valid": true,
            "Price": 25
        }]
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
  <Sends>
    <SendInfo>
      <ClientUID>1234</ClientUID>
      <ClientName>Demo Company</ClientName>
      <RedirectURL></RedirectURL>
      <Valid>true</Valid>
      <Price>25</Price>
    </SendInfo>
    <SendInfo>
      <ClientUID>Acme Company</ClientUID>
      <ClientName></ClientName>
      <RedirectURL></RedirectURL>
      <Valid>true</Valid>
      <Price>25</Price>
    </SendInfo>
  </Sends>
</PostResponse>

Async Request

POST /processor/insert/returnsends/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="" returnurl="">
<Lead reference="">
...
</Lead>
</Leads>

Async Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create Lead (include a list of who the lead should be transferred to)   XML

This method creates a new lead in the system, and will return a list of names and numbers that the call should be transferred to. Note: This feature requires approval and will not function unless permission is granted. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer attribute Required Your lead source identifier
lid integer attribute Required Your lead type identifier
aid integer attribute Your campaign identifier
password string attribute Required
(if provided)
Your API password provided in your documentation
(required if provided)
reference string attribute Reference value to store on the record for reporting purposes
response_type string url segement Your desired response type json or xml
returnurl string attribute For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com
ClientInfos array of agents List of agents array
ClientInfos.ClientUID integer Identifier for the client the lead was sent to 9999999
ClientInfos.ClientName string Name of the client the lead was sent to Demo Company
ClientInfos.AgentName string Name of the agent to transfer to John Smith
ClientInfos.AgentPhone bool Phone number of the agent to send to 7025551212

Request

POST /processor/insert/transfer/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="">
<Lead reference="">
...
</Lead>
</Leads>

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": "",
    "ClientInfos" : [
        {
            "ClientUID": 1234,
            "ClientName": "Demo Company",
            "AgentName": "John Smith",
            "AgentPhone": "7025551212""
        },
        {
            "ClientUID": 5679,
            "ClientName": "Acme Company",
            "AgentName": "Bob McCarthy",
            "AgentPhone": "6025551212"
        }]
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
  <ClientInfos>
    <ClientInfo>
      <ClientUID>1234</ClientUID>
      <ClientName>Demo Company</ClientName>
      <AgentName>John Smith</AgentName>
      <AgentPhone>7025551212</AgentPhone>
    </ClientInfo>
    <ClientInfo>
      <ClientUID>5679</ClientUID>
      <ClientName>Acme Company</ClientName>
      <AgentName>Bob McCarthy</AgentName>
      <AgentPhone>6025551212</AgentPhone>
    </ClientInfo>
</PostResponse>

Async Request

POST /processor/insert/transfer/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="" returnurl="">
<Lead reference="">
...
</Lead>
</Leads>

Async Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create Call Lead   XML

This method creates a new lead with call details in the system. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer attribute Required Your lead source identifier
lid integer attribute Required Your lead type identifier
aid integer attribute Your campaign identifier
password string attribute Required
(if provided)
Your API password provided in your documentation
(required if provided)
reference string attribute Reference value to store on the record for reporting purposes
ivrnumber string body Required Phone number that the lead called
callduration integer body Required Call duration in seconds
callresult string body Result of call
calldate date/time body Date and time of call (expressed in Pacific Time)
response_type string url segement Your desired response type json or xml
returnurl string attribute For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com

Request

POST /processor/insert/transfer/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="">
<Lead reference="">
<IVRNumber></IVRNumber>
<CallDuration></CallDuration>
<CallResult></CallResult>
<CallDate></CallDate>
...
</Lead>
</Leads>

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": "",
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
</PostResponse>

Request

POST /processor/insert/calldata/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="" returnurl="">
<Lead reference="">
<IVRNumber></IVRNumber>
<CallDuration></CallDuration>
<CallResult></CallResult>
<CallDate></CallDate>
...
</Lead>
</Leads>

Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create General Lead   JSON

This method creates a new lead in the system. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
source.vid integer body Required Your lead source identifier
source.lid integer body Required Your lead type identifier
source.aid integer body Your campaign identifier
source.password string body Required
(if provided)
Your API password provided in your documentation
(required if provided)
source.sendDelay integer body The amount of hours to delay sending the lead
lead.properties.reference string body Reference value to store on the record for reporting purposes
lead.properties.noSell boolean body Should the lead not be sent
response_type string url segement Required
(for async)
Your desired response type json or xml
returnurl string body For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com

Request

POST /processor/insert/general/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: application/json

{
    "source": {
        "vid": 0,
        "aid": 0,
        "lid": 0,
        "password": "",
        "sendDelay": 0.0,
        "returnURL": ""
    },
    "leads": [
        {
            "properties": {
                "reference": "",
                "noSell": false
            },
            "fields": {
                "FirstName": "",
                "LastName": "",
                ...
            }
        }
    ]
}

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": ""
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
</PostResponse>

Async Request

POST /processor/insert/general/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="" returnurl="">
<Lead reference="">
...
</Lead>
</Leads>

Async Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create Lead (include a list of who the lead was sent to)   JSON

This method creates a new lead in the system, and will return a list of names and prices of where the lead was sent. Note: This feature requires approval and will not function unless permission is granted. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
source.vid integer body Required Your lead source identifier
source.lid integer body Required Your lead type identifier
source.aid integer body Your campaign identifier
source.password string body Required
(if provided)
Your API password provided in your documentation
(required if provided)
source.sendDelay integer body The amount of hours to delay sending the lead
lead.properties.reference string body Reference value to store on the record for reporting purposes
lead.properties.noSell boolean body Should the lead not be sent
response_type string url segement Required
(for async)
Your desired response type json or xml
returnurl string body For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com
Sends array of sends List of lead delivery sends array
Sends.ClientUID integer Identifier for the client the lead was sent to 9999999
Sends.ClientName string Name of the client the lead was sent to Demo Company
Sends.RedirectURL string Redirect url requested by the client https://example.com
Sends.Valid bool Was the send successful true
false
Sends.Price decimal Price of the lead that was paid by the client 25

Request

POST /processor/insert/general/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: application/json

{
    "source": {
        "vid": 0,
        "aid": 0,
        "lid": 0,
        "password": "",
        "sendDelay": 0.0,
        "returnURL": ""
    },
    "leads": [
        {
            "properties": {
                "reference": "",
                "noSell": false
            },
            "fields": {
                "FirstName": "",
                "LastName": "",
                ...
            }
        }
    ]
}

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": "",
    "Sends" : [
        {
            "ClientUID": 1234,
            "ClientName": "Demo Company",
            "RedirectURL": "",
            "Valid": true,
            "Price": 25
        },
        {
            "ClientUID": 5679,
            "ClientName": "Acme Company",
            "RedirectURL": "",
            "Valid": true,
            "Price": 25
        }]
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
  <Sends>
    <SendInfo>
      <ClientUID>1234</ClientUID>
      <ClientName>Demo Company</ClientName>
      <RedirectURL></RedirectURL>
      <Valid>true</Valid>
      <Price>25</Price>
    </SendInfo>
    <SendInfo>
      <ClientUID>Acme Company</ClientUID>
      <ClientName></ClientName>
      <RedirectURL></RedirectURL>
      <Valid>true</Valid>
      <Price>25</Price>
    </SendInfo>
  </Sends>
</PostResponse>

Async Request

POST /processor/insert/returnsends/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="" returnurl="">
<Lead reference="">
...
</Lead>
</Leads>

Async Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create Lead (include a list of who the lead should be transferred to)   JSON

This method creates a new lead in the system, and will return a list of names and numbers that the call should be transferred to. Note: This feature requires approval and will not function unless permission is granted. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
source.vid integer body Required Your lead source identifier
source.lid integer body Required Your lead type identifier
source.aid integer body Your campaign identifier
source.password string body Required
(if provided)
Your API password provided in your documentation
(required if provided)
source.sendDelay integer body The amount of hours to delay sending the lead
lead.properties.reference string body Reference value to store on the record for reporting purposes
lead.properties.noSell boolean body Should the lead not be sent
response_type string url segement Required
(for async)
Your desired response type json or xml
returnurl string body For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com
ClientInfos array of agents List of agents array
ClientInfos.ClientUID integer Identifier for the client the lead was sent to 9999999
ClientInfos.ClientName string Name of the client the lead was sent to Demo Company
ClientInfos.AgentName string Name of the agent to transfer to John Smith
ClientInfos.AgentPhone bool Phone number of the agent to send to 7025551212

Request

POST /processor/insert/general/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: application/json

{
    "source": {
        "vid": 0,
        "aid": 0,
        "lid": 0,
        "password": "",
        "sendDelay": 0.0,
        "returnURL": ""
    },
    "leads": [
        {
            "properties": {
                "reference": "",
                "noSell": false
            },
            "fields": {
                "FirstName": "",
                "LastName": "",
                ...
            }
        }
    ]
}

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": "",
    "ClientInfos" : [
        {
            "ClientUID": 1234,
            "ClientName": "Demo Company",
            "AgentName": "John Smith",
            "AgentPhone": "7025551212""
        },
        {
            "ClientUID": 5679,
            "ClientName": "Acme Company",
            "AgentName": "Bob McCarthy",
            "AgentPhone": "6025551212"
        }]
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
  <ClientInfos>
    <ClientInfo>
      <ClientUID>1234</ClientUID>
      <ClientName>Demo Company</ClientName>
      <AgentName>John Smith</AgentName>
      <AgentPhone>7025551212</AgentPhone>
    </ClientInfo>
    <ClientInfo>
      <ClientUID>5679</ClientUID>
      <ClientName>Acme Company</ClientName>
      <AgentName>Bob McCarthy</AgentName>
      <AgentPhone>6025551212</AgentPhone>
    </ClientInfo>
</PostResponse>

Async Request

POST /processor/insert/transfer/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="" returnurl="">
<Lead reference="">
...
</Lead>
</Leads>

Async Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Create Call Lead   JSON

This method creates a new lead with call details in the system. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
source.vid integer body Required Your lead source identifier
source.lid integer body Required Your lead type identifier
source.aid integer body Your campaign identifier
source.password string body Required
(if provided)
Your API password provided in your documentation
(required if provided)
source.sendDelay integer body The amount of hours to delay sending the lead
lead.properties.reference string body Reference value to store on the record for reporting purposes
lead.properties.noSell boolean body Should the lead not be sent
lead.properties.ivrnumber string body Required Phone number that the lead called
lead.properties.callduration integer body Required Call duration in seconds
lead.properties.callresult string body Result of call
lead.properties.calldate date/time body Date and time of call (expressed in Pacific Time)
response_type string url segement Required
(for async)
Your desired response type json or xml
returnurl string body For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com

Request

POST /processor/insert/general/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: application/json

{
    "source": {
        "vid": 0,
        "aid": 0,
        "lid": 0,
        "password": "",
        "sendDelay": 0.0,
        "returnURL": ""
    },
    "leads": [
        {
            "properties": {
                "reference": "",
                "noSell": false,
                "ivrNumber": "",
                "callDuration": 0,
                "callResult": "",
                "callDate": "11/13/2020 12:15 PM"
            },
            "fields": {
                "FirstName": "",
                "LastName": "",
                ...
            }
        }
    ]
}

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead was accepted",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": ""
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead was accepted</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
</PostResponse>

Request

POST /processor/insert/calldata/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: application/xml

<Leads vid="" lid="" aid="" password="" returnurl="">
<Lead reference="">
<IVRNumber></IVRNumber>
<CallDuration></CallDuration>
<CallResult></CallResult>
<CallDate></CallDate>
...
</Lead>
</Leads>

Response

JSON


{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Update Lead

This method updates a new lead with new fields supplied. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer query Required Your lead source identifier
lid integer query Required Your lead type identifier
lpleaduid integer query Required Lead identifier for lead to be updated

Response Properties

Property Type Description Example Values
PostID unique identifier Log identifier for transaction guid
isValidPost bool Was the transaction successful true
false
ResponseType response_type Type of response 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
ResponseDetail string Details about the transaction and why it may have failed Lead was accepted
LeadIdentifier integer Identifier of record submitted 123456789
VendorAccountAssigned integer Identifier of campaign record assigned to 123456789
PendingQCReview bool Is record under review true
false
RedirectURL string URL user should be redirect to https://example.com

Request

POST /processor/update/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&lpleaduid=&...

Response

JSON

{
    "PostID": "f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "isValidPost": true,
    "ResponseType": "No_Error",
    "ResponseDetails": "Lead information updated",
    "LeadIdentifier": 999999999,
    "VendorAccountAssigned": 99,
    "PendingQCReview": false,
    "Price": 25,
    "RedirectURL": ""
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PostResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <isValidPost>true</isValidPost>
  <ResponseType>No_Error</ResponseType>
  <ResponseDetails>Lead information updated</ResponseDetails>
  <LeadIdentifier>999999999</LeadIdentifier>
  <VendorAccountAssigned>99</VendorAccountAssigned>
  <PendingQCReview>false</PendingQCReview>
  <Price>25</Price>
  <RedirectURL />
</PostResponse>

PING

This method pings the system to determine eligibility of the lead data being submitted. Submit only the data that is used to determine eligibility, contact information should be excluded from the post. Once you have received a response with an order ID, use that ID to post the final lead. Fields are dynamic and you should refer to your post documentation on which fields need to be posted.

Request Parameters

Parameter Type Position Required Description
vid integer query Required Your lead source identifier
lid integer query Required Your lead type identifier
aid integer query Required Your campaign identifier
password string query Required
(if provided)
Your API password provided in your documentation
(required if provided)
response_type string url segement Your desired response type json or xml
returnurl string url segement For async processing, this url will be called when processing is completed with the response details.

Response Properties

Property Type Description Example Values
WillAccept bool Was the transaction successful true
false
OrderID unique identifier If accepted an order ID will be created guid
EstimatedPrice decimal Estimated payout for the request submitted 25
OrderExpiresOn datetime Date and time that the order ID will expire 4/30/2020 1:53:45 PM
Response string Details about the transaction and why it may have failed Coverage found, please supply Order ID in POST

Request

POST /processor/insert/ping/[response_type] HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=&...

Response

JSON

{
    "WillAccept": true,
    "RequestID": "ce77b056-0103-4cf8-badf-2e73087b6e5a",
    "OrderID": "7cef1c61-916c-4ea8-b79f-5572e73c4602",
    "EstimatedPrice": "25",
    "OrderExpiresOn": "4/30/2020 1:53:45 PM",
    "Response": "Coverage found, please supply Order ID in POST"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<PingResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <WillAccept>true</WillAccept>
  <RequestID>ce77b056-0103-4cf8-badf-2e73087b6e5a</RequestID>
  <OrderID>7cef1c61-916c-4ea8-b79f-5572e73c4602</OrderID>
  <EstimatedPrice>25</EstimatedPrice>
  <OrderExpiresOn>4/30/2020 1:53:45 PM</OrderExpiresOn>
  <Response>Coverage found, please supply Order ID in POST</Response>
</PingResponse>

Async Request

POST /processor/insert/ping/[response_type]/async HTTP/1.1
host: leads.leadexec.net
content-type: x-www-form-urlencoded

vid=&lid=&aid=&password=&returnurl=...

Async Response

JSON

{
    "QueueSuccessful":true,
    "PostID":"f5666260-1c2c-4bd5-9611-bb1387ca2397",
    "ResponseDetails":"Lead has been queued for processing",
    "StatusURL":"http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397"
}

XML

<?xml version="1.0" encoding="utf-8"?>
<LeadQueueResponse xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <QueueSuccessful>true</QueueSuccessful>
  <PostID>f5666260-1c2c-4bd5-9611-bb1387ca2397</PostID>
  <ResponseDetails>Lead has been queued for processing</ResponseDetails>
  <StatusURL>http://leads.leadexec.net/information/queuestatus/f5666260-1c2c-4bd5-9611-bb1387ca2397</StatusURL>
</LeadQueueResponse>

Code Examples


C#

public string SubmitPOST()
{
    ASCIIEncoding encoding = new ASCIIEncoding();
    byte[] data = encoding.GetBytes("FirstName=John&LastName=Doe&Email=noemail@leads.com");

    string deliveryAddress = "https://leads.leadexec.net/processor/insert/general";

    HttpWebRequest RequestObj = (HttpWebRequest)WebRequest.Create(deliveryAddress);
    RequestObj.Method = "POST";
    RequestObj.ContentType = "application/x-www-form-urlencoded";
    RequestObj.ContentLength = data.Length;

    Stream RequestStream = RequestObj.GetRequestStream();
    RequestStream.Write(data, 0, data.Length);
    RequestStream.Close();

    HttpWebResponse HttpResponse;
    HttpResponse = (HttpWebResponse)RequestObj.GetResponse();

    Stream streamResponse = HttpResponse.GetResponseStream();
    StreamReader streamRead = new StreamReader(streamResponse);

    return streamRead.ReadToEnd();
}

Classic ASP

<%
    Dim objWinHttp
    Dim strResponseStatus
    Dim strResponseText
    Set objWinHttp = Server.CreateObject("WinHttp.WinHttpRequest.5.1")
    objWinHttp.Open "POST", "https://leads.leadexec.net/processor/insert/general", False
    objWinHttp.SetRequestHeader "Content-Type", "application/x-www-form-urlencoded"
    objWinHttp.Send "Name=John&Date=" & Server.URLEncode(Now())
    strResponseStatus = objWinHttp.Status & " " & objWinHttp.StatusText
    strResponseText = objWinHttp.ResponseText
    Set objWinHttp = Nothing
%>

PHP

<?php
    $c = curl_init();
    curl_setopt($c, CURLOPT_URL, 'https://leads.leadexec.net/processor/insert/general');
    curl_setopt($c, CURLOPT_POST, true);
    curl_setopt($c, CURLOPT_POSTFIELDS, 'FirstName=John&LastName=Doe&Email=noemail@leads.com');
    curl_exec ($c);
    curl_close ($c);
?>

Perl

use LWP::UserAgent;

my $ua = new LWP::UserAgent;
my $response = $ua->post('https://leads.leadexec.net/processor/insert/general',
{ 
    FirstName => 'John', 
    LastName => 'Doe', 
    Email => 'noemail@leads.com'
});

my $content = $response->content;

Java

function DoPOST()
{
    String data = URLEncoder.encode("FirstName", "UTF-8") + "=" + URLEncoder.encode("John", "UTF-8");
    data += "&" + URLEncoder.encode("LastName", "UTF-8") + "=" + URLEncoder.encode("Doe", "UTF-8");
    data += "&" + URLEncoder.encode("Email", "UTF-8") + "=" + URLEncoder.encode("noemail@leads.com", "UTF-8");
    URL url = new URL("https://leads.leadexec.net/processor/insert/general");
    URLConnection conn = url.openConnection();
    conn.setDoOutput(true);
    OutputStreamWriter wr = new OutputStreamWriter(conn.getOutputStream());
    wr.write(data);
    wr.flush();
    BufferedReader rd = new BufferedReader(new InputStreamReader(conn.getInputStream()));
    String line;
    while ((line = rd.readLine()) != null) {
            // Process line...
    }
    wr.close();
    rd.close();
}