ClickDealer

Posting instructions - Campaign (128468) [API] HQ Gutter /US *Sensitive* - RevShare


This page contains instructions on how to post leads to campaign (128468) [API] HQ Gutter /US *Sensitive* - RevShare, details on the format of the posting fields and information about the response format

Request information

Content-Type
application/x-www-form-urlencoded
Content type for the request body
Accept
application/json / application/xml
Use this header to get the response in JSON or XML format.
Parameter name
Required
Data type
Description
Example
max_response_time
No
Integer
Pass the maximum time in seconds for receiving response. Note: the bigger timeout value you’re sending, the higher probability of lead sale is
90

Request fields

#
Field name
Required
Data type
Description
Example
1
income_credit
No
LIST
household_income + credit_rate
1-1
2
household_income
No
LIST
Income amount
1
3
credit_rate
No
LIST
User's credit rate
1
4
tcpa_text
No
STRING
TCPA Compliance text from the landing page
5
homeowner
Yes
LIST
If the user owns the home, possible values: Yes, No
Yes,No
6
gutter_covers
No
LIST
If user is interested in gutter covers
Yes,No
7
location_type
No
LIST
Type of the location where gutters need to be installed
1,2
8
trusted_form_cert_id
Yes
STRING
Trusted form cert ID, obtained using Trusted form script on the landing page
9
authorized_to_make_changes
Yes
LIST
If the user is authorized to make changes, possible values: Yes, No
Yes,No
10
session_length
Yes
INT
Session length of the user on our LP, i.e how much time (in seconds) the user has been on your landing page
11
project
Yes
LIST
Type of the project (see the list of possible values below). Ex: 1
1,2
12
trusted_form_cert_url
Yes
STRING
Trusted form cert URL, obtained using Trusted form script on the landing page
13
journaya_lead_id
Yes
STRING
Journaya lead ID obtained using Journaya script on the landing page
14
zipcode
Yes
INT
US-formatted zip code
15
s5
No
STRING
S5
16
s4
No
STRING
S4
17
s3
No
STRING
S3 (pass FB pixel ID here)
18
s2
No
STRING
S2 (usually used for passing clickid for the purpose of s2s postback tracking)
19
s1
No
STRING
Your subsource of the traffic (for reporting purpose in the affiliate portal)
20
referrer
Yes
STRING
Website address where lead generated (ex. https://yourwebsite.com)
21
phone
Yes
PHONE
US valid phone number, without phone code (ex. 2255783600)
22
address
Yes
STRING
Address
23
city
Yes
CITY
City
24
region
Yes
REGION
2-letter US state abbreviation (ex. IN)
25
country_iso_2
Yes
COUNTRY_ISO_2
Country_iso_2, 2-letter abbreviaton (ex. US)
26
useragent
Yes
STRING
Useragent string of the user
27
ip
Yes
IP
IP address (can be both IPv4 or IPv6)
28
email
Yes
EMAIL
Email of the user
29
last_name
Yes
LAST_NAME
Last name of the user
30
first_name
Yes
FIRST_NAME
First name of the user

Responses

If you want to receive a response immediately after the lead is successfully validated without waiting for lead's sale, add the async_response=true GET parameter to the request URL.

Please note: in this case "AutologinUrl" and "Payout" values will not be sent in the response, since they can only be obtained on the lead's sale.

Response body
STATUS 40X - FAILED

{
    "Result" : "Failed",
    "Response_code" : "400",
    "Message" : "Required fields missing: [email]"
}

{
    "Result" : "Failed",
    "Response_code" : "400",
    "Message" : "Request validation failed"
}
STATUS 200 OK - SUCCESS

{
    "Result": "Success",
    "LeadId": "9f57b396d89c408190ba1ec4cc93a61d68x66",
    "AutologinUrl": "https://thisisautologinurlfromtherequest.com",
    "Payout": 2.25,
    "Message": "Lead accepted"
}
STATUS 200 OK - SUCCESS (async response)

{
    "Result" : "Success",
    "LeadId" : "414ec616488c4abc9e42e40c24c0c38e",
    "Message" : "Lead accepted"
}
STATUS 200 OK - SUCCESS (DELAYED SELLING)

{
    "Result" : "Success",
    "LeadId" : "414ec616488c4abc9e42e40c24c0c38e",
    "Message" : "Lead accepted - Delayed lead selling"
}
STATUS 200 OK - REJECTED

{
    "Result": "Failed",
    "LeadId": "9f57b396d89c408190ba1ec4cc93a61d68x66",
    "AutologinUrl": "",
    "Message": "Lead rejected by lead buyer"
}

Testing

In order to post test lead include post_test=true parameter in the request URL as GET parameter

List values

Field name Possible values Mapping
income_credit 1-1 $50,000 to $74,999 - Excellent
1-2 $50,000 to $74,999 - Good
1-3 $50,000 to $74,999 - Fair
1-4 $50,000 to $74,999 - Poor
2-1 $75,000 to $99,999 - Excellent
2-2 $75,000 to $99,999 - Good
2-3 $75,000 to $99,999 - Fair
2-4 $75,000 to $99,999 - Poor
3-1 $100,000 to $124,999 - Excellent
3-2 $100,000 to $124,999 - Good
3-3 $100,000 to $124,999 - Fair
3-4 $100,000 to $124,999 - Poor
4-1 $125,000+ - Excellent
4-2 $125,000+ - Good
4-3 $125,000+ - Fair
4-4 $125,000+ - Poor
household_income A Under $10,000
B $10,000 - $14,999
C $15,000 - $19,999
D $20,000 - $24,999
E $25,000 - $29,999
F $30,000 - $34,999
G $35,000 - $39,999
H $40,000 - $44,999
I $45,000 - $49,999
J $50,000 - $54,999
K $55,000 - $59,999
L $60,000 - $64,999
M $65,000 - $74,999
N $75,000 - $99,999
O $100,000 - $149,999
P $150,000 - $174,999
Q $175,000 - $199,999
R $200,000 - $249,999
S $250,000+
credit_rate A 800+
B 750 - 799
C 700 - 749
D 650 - 699
E 600 - 649
F 550 - 599
G 500 - 549
H under 499
homeowner Yes
No
gutter_covers Yes
No
location_type 1 Home
2 Business
authorized_to_make_changes Yes
No
project 1 Install
2 Repair