ClickDealer - Post instructions

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	tcpa_text	No	STRING	TCPA Compliance text from the landing page
2	homeowner	Yes	LIST	If the user owns the home, possible values: Yes, No	Yes,No
3	gutter_covers	No	LIST	If user is interested in gutter covers	Yes,No
4	location_type	No	LIST	Type of the location where gutters need to be installed	1,2
5	trusted_form_cert_id	Yes	STRING	Trusted form cert ID, obtained using Trusted form script on the landing page
6	authorized_to_make_changes	Yes	LIST	If the user is authorized to make changes, possible values: Yes, No	Yes,No
7	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
8	project	Yes	LIST	Type of the project (see the list of possible values below). Ex: 1	1,2
9	trusted_form_cert_url	Yes	STRING	Trusted form cert URL, obtained using Trusted form script on the landing page
10	journaya_lead_id	Yes	STRING	Journaya lead ID obtained using Journaya script on the landing page
11	zipcode	Yes	INT	US-formatted zip code
12	s5	No	STRING	S5
13	s4	No	STRING	S4
14	s3	No	STRING	S3 (pass FB pixel ID here)
15	s2	No	STRING	S2 (usually used for passing clickid for the purpose of s2s postback tracking)
16	s1	No	STRING	Your subsource of the traffic (for reporting purpose in the affiliate portal)
17	referrer	Yes	STRING	Website address where lead generated (ex. https://yourwebsite.com)
18	phone	Yes	PHONE	US valid phone number, without phone code (ex. 2255783600)
19	address	Yes	STRING	Address
20	city	Yes	CITY	City
21	region	Yes	REGION	2-letter US state abbreviation (ex. IN)
22	country_iso_2	Yes	COUNTRY_ISO_2	Country_iso_2, 2-letter abbreviaton (ex. US)
23	useragent	Yes	STRING	Useragent string of the user
24	ip	Yes	IP	IP address (can be both IPv4 or IPv6)
25	email	Yes	EMAIL	Email of the user
26	last_name	Yes	LAST_NAME	Last name of the user
27	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.

Failed responses:

400 Affiliate validation error, Campaign validation error, Creative validation error, Lead field validation error [value], Required fields missing [field name 1, field name 2…], Lead Distribution validation error, Lead with the same email has been recently registered, Lead with the same IP has been recently registered.

401 Api_key is missing, Wrong API key, Affiliate_id is missing.

404 Not Found.

Successful response:

200 OK.

Response body

STATUS 40X - FAILED

JSON
XML


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

{
    "Result" : "Failed",
    "Response_code" : "400",
    "Message" : "Request validation failed"
}


<Response xmlns="">
    <Result>Failed</Result>
    <Response_code>400</Response_code>
    <Message>Required fields missing: [email]</Message>
</Response>

<Response xmlns="">
    <Result>Failed</Result>
    <Response_code>400</Response_code>
    <Message>Response validation failed</Message>
</Response>

STATUS 200 OK - SUCCESS

JSON
XML


{
    "Result": "Success",
    "LeadId": "9f57b396d89c408190ba1ec4cc93a61d68x66",
    "AutologinUrl": "https://thisisautologinurlfromtherequest.com",
    "Payout": 2.25,
    "Message": "Lead accepted"
}


<Response xmlns="">
    <Result>Success</Result>
    <LeadId>9f57b396d89c408190ba1ec4cc93a61d68x66</LeadId>
    <AutologinUrl>https://thisisautologinurlfromtherequest.com</AutologinUrl>
    <Payout>2.25</Payout>
    <Message>Lead accepted</Message>
</Response>

STATUS 200 OK - SUCCESS (async response)

JSON
XML


{
    "Result" : "Success",
    "LeadId" : "414ec616488c4abc9e42e40c24c0c38e",
    "Message" : "Lead accepted"
}


<Response xmlns="">
    <Result>Success</Result>
    <LeadId>414ec616488c4abc9e42e40c24c0c38e</LeadId>
    <Message>Lead accepted</Message>
</Response>

STATUS 200 OK - SUCCESS (DELAYED SELLING)

JSON
XML


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


<Response xmlns="">
    <Result>Success</Result>
    <LeadId>414ec616488c4abc9e42e40c24c0c38e</LeadId>
    <Message>Lead accepted - Delayed lead selling</Message>
</Response>

STATUS 200 OK - REJECTED

JSON
XML


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


<Response xmlns="">
    <Result>Failed</Result>
    <LeadId>9f57b396d89c408190ba1ec4cc93a61d68x66</LeadId>
    <AutologinUrl></AutologinUrl>
    <Message>Lead rejected by lead buyer</Message>
</Response>

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.

Posting instructions - Campaign (12345) [API] Gutter

This page contains instructions on how to post leads to campaign (12345) [API] Gutter, details on the format of the posting fields and information about the response format

Request information

Request fields

Responses

Testing

List values