Fields

The following fields will be captured by this campaign. For examples of how to submit these fields, please see the examples below.

Field Name Type Format Required Description
lp_campaign_id Numeric 123, -12.34 Yes Must be set to: 13424
lp_supplier_id Numeric 123, -12.34 Yes Must be set to: 27633
lp_key Text Text Yes Must be set to: 37hr3ofdee6
lp_action Text Text No Send test for testing
lp_subid1 Text Text No sub_id1, max 75 chars
lp_subid2 Text Text No sub_id2, max 75 chars
first_name Text Text No Any text
last_name Text Text No Any text
email Email [email protected] No Valid formatted email address
phone Phone 6503271100 No 10 digits
date_of_birth Age 2015-07-21 No Format: YYYY-MM-DD
gender Multiple values, one choice Text No Allowed values:
  • Female
  • Other
  • Mâle
address Text Text No Any text
city Text Text No Any text
state State CA, NY No Any valid US state, 2 letter
zip_code Postal code 78124 No 5 digit
ip_address IP address 127.0.0.1 No IPv4, IPv6
user_agent Text Text No Any text
landing_page_url URL http(s)://example.com No URL with protocol
jornaya_leadid Text Text No Any text
trustedform_cert_url URL http(s)://example.com No URL with protocol
home_owner Multiple values, one choice Text No Allowed values:
  • Yes
  • No
time_frame Multiple values, one choice Text No Allowed values:
  • Immediately
  • Within 1 month
  • 1-3 months
  • 3+ months
monthly_electric_bill Multiple values, one choice Text No Allowed values:
  • $0-$50
  • $51-$100
  • $101-$150
  • $151-$200
  • $201-$300
  • $300-$400
  • $400+
utlity_provider Text Text No Any text
roof_shade Multiple values, one choice Text No Allowed values:
  • No Shade
  • Full Shade
  • Partial Shade
  • Not Sure
property_type Multiple values, one choice Text No Allowed values:
  • Single Family
  • Multi Family
  • Apartment
  • Condo
  • Manufactured
  • Townhome
  • Duplex
  • Commercial
credit_rating Multiple values, one choice Text No Allowed values:
  • Poor
  • Fair
  • Good
  • Excellent
roof_type Multiple values, one choice Text No Allowed values:
  • Tile
  • Shake shingle
  • Flat
  • Gable
  • Cross gabled
  • Cross hipped

IMPORTANT: fields are case sensitive. first_name is not the same as First_Name

Ingesting leads

We only accept POST HTTP requests. Requests can be sent either as FORM or JSON.

Method: POST
URL: https://example.leadprosper.tech/leadprosper/ingest
FORM

Headers:

Content-Type: application/x-www-form-urlencoded

Payload:

lp_campaign_id=13424&lp_supplier_id=27633&lp_key=37hr3ofdee6&lp_action=&lp_subid1=&lp_subid2=&first_name=Jeramie&last_name=Samson&[email protected]&phone=9402389709&date_of_birth=1989-03-15&gender=Mâle&address=6611 Mosciski Walks&city=Port Lindseymouth&state=FL&zip_code=32801&ip_address=108.43.213.219&user_agent=Mozilla/5.0 (compatible; MSIE 5.0; Windows NT 5.2; Trident/4.0)&landing_page_url=https://example.com/nihil&jornaya_leadid=B8A2E508-9C91-4FE2-86CC-F51F989FF434&trustedform_cert_url=https://cert.trustedform.com/a0c3256943192f2fcb4aae0d11aaffc2af251c8f&home_owner=Yes&time_frame=1-3 months&monthly_electric_bill=$151-$200&utlity_provider=December&roof_shade=No Shade&property_type=Duplex&credit_rating=Fair&roof_type=Gable
HTTP
Copy
JSON

Headers:

Content-Type: application/json

Payload:

{
    "lp_campaign_id": "13424",
    "lp_supplier_id": "27633",
    "lp_key": "37hr3ofdee6",
    "lp_action": "",
    "lp_subid1": "",
    "lp_subid2": "",
    "first_name": "Jeramie",
    "last_name": "Samson",
    "email": "[email protected]",
    "phone": "9402389709",
    "date_of_birth": "1989-03-15",
    "gender": "M\u00e2le",
    "address": "6611 Mosciski Walks",
    "city": "Port Lindseymouth",
    "state": "FL",
    "zip_code": 32801,
    "ip_address": "108.43.213.219",
    "user_agent": "Mozilla/5.0 (compatible; MSIE 5.0; Windows NT 5.2; Trident/4.0)",
    "landing_page_url": "https://example.com/nihil",
    "jornaya_leadid": "B8A2E508-9C91-4FE2-86CC-F51F989FF434",
    "trustedform_cert_url": "https://cert.trustedform.com/a0c3256943192f2fcb4aae0d11aaffc2af251c8f",
    "home_owner": "Yes",
    "time_frame": "1-3 months",
    "monthly_electric_bill": "$151-$200",
    "utlity_provider": "December",
    "roof_shade": "No Shade",
    "property_type": "Duplex",
    "credit_rating": "Fair",
    "roof_type": "Gable"
}
JSON
Copy

Testing

If you wish to test your setup to ensure that all the fields are correctly sent, you can add the following parameters to the API URL. Please note that testing will skip any configured filters or any cap limits.

Parameter Value Description
lp_action test Required for testing only

Responses

All responses are sent back in JSON format. There are 3 possible responses: ACCEPTED, DUPLICATED, ERROR.

Accepted response 

{
    "id": "19a63c72-8709-4256-b099-09eb07c6f810",
    "lead_id": "b59OMX4B8J-QmL7XJ211",
    "status": "ACCEPTED",
    "code": 0,
    "message": ""
}
JSON
Copy

Duplicated response 

{
    "id": "1d79d5c8-cf7a-4800-806e-b9b8bf2c96b9",
    "lead_id": "b59OMX4B8J-QmL7XJ211",
    "status": "DUPLICATED",
    "code": 1009,
    "message": "Error: duplicate lead"
}
JSON
Copy

Error response 

{
    "id": "f2be15b3-291b-4677-8a4e-75af489740e2",
    "lead_id": "b59OMX4B8J-QmL7XJ211",
    "status": "ERROR",
    "code": 1006,
    "message": "Error: lead rejected"
}
JSON
Copy

Error codes

Code Message
1018 Error: account inactive
1048 Error: buyer budget cap exceeded
1040 Error: buyer configuration changed between PING and POST request
1016 Error: buyer configuration error
1024 Error: buyer configuration is incomplete
1041 Error: buyer excluded by lp_bids
1039 Error: buyer was not found in the PING request
1042 Error: buyer was not successful in the PING request
1000,1022,1031 Error: could not process request. Contact your campaign manager
1011,1012 Error: could not process request. The campaign is paused. Contact your campaign manager
1007,1008,1009 Error: duplicate lead
1003 Error: field has wrong format
1002 Error: field is required
1034 Error: invalid lp_ping_id
1001 Error: invalid request URL
1015,1017 Error: lead failed validation
1005,1006,1013,1019,1020,1021,1025,1026,1046 Error: lead rejected
1010,1027,1028 Error: lead rejected - cap reached
1038 Error: lp_bids contains invalid bid(s)
1043 Error: lp_ping_id was already processed
1014 Error: missing or invalid field value
1032,1033 Error: PING rejected
1036 Error: POST data does not match PING data
1037 Error: POST not accepted due to PING failure
1035 Error: POST sent outside of PING timeout window
1044 Error: pre-ping dupe checker is not enabled on this campaign
1045 Error: skipped by repost configuration
1047 Error: supplier budget cap exceeded
1004,1029,1030 Rejected by filter

Help

Questions? Please email: [email protected]