Follow

Calling the Inbound Data API

You will use HTTP GET or POST to access the module using the following URL and Fields.  Each lead should be sent individually and will receive a response as to the final disposition of the lead in real-time.  All values must be URL encoded.

URL: http://{subscriber}.leadshot.net/gateway/gateway.php

Data Fields:

Field Name

Acceptable Values or Format

Description

pid

Assigned Variable

Publisher ID assigned by the Partners module

oid

Assigend Variable

Offer ID assigned when the campaign is created

psid

Open text

An open variable that is used to track sub affiliates

email

Proper email syntax

Users email address

fname

Open text

Users first name

lname

Open text

Users last name

phone1

XXX-XXX-XXXX

Users home phone

phone2

XXX-XXX-XXXX

Users work phone

phone3

XXX-XXX-XXXX

Users cellular phone

gender

‘M’ or ‘F’

Users gender

dob

YYYY-MM-DD

Users date of birth

address

Open text

Users mailing address

city

Open text

Users mailing city

state

ISO 3166-2 Standard

 i.e.'CA'

Users mailing state

zip

Open text

Users mailing zip code

country

ISO 3166-1 alpha-3 Standard

i.e.'USA'

Users mailing country

ip

Proper ip syntax

Users ip address

cv1

Open text

Custom value for campaign (cv1 to cv85 are available) 

cv85

Open text Custom value for campaign (cv1 to cv85 are available) 

 

 

 

The Response

Once you submit a lead to the API it will process it and provide a response. 

Response

Description

__success__

__lead_received__

The lead was received properly

__failure__

__invalid_oid__

An invalid oid was submitted

__failure__

__invalid_oid__

An invalid pid was submitted

__failed__

__invalid_pid_oid_combination__

An lead was submitted by a publisher id that is not approved for a give offer id

__failure__

__inactive_oid__

The offer id submitted is not active

__failed__

__invalid_field_value__

__email__

The syntax of the email submitted is incorrect

__failed__

__invalid_age__

__{$agesubmitted}__

The age submitted is outside the range set in the campaign filter config

__failed__

__daily_cap_reached__

The daily lead cap has been reached for the the campaign

__failed__

__daily_pub_cap_reached__

The daily lead cap has been reached for the pid/oid combination

__failed__

__total_cap_reached__

The total lead cap has been reached for the the campaign

__failed__

__total_pub_cap_reached__

The total lead cap has been reached for the pid/oid combination

__failed__

__invalid_field_value__ 

__{$fieldname}__

The value submitted was rejected by defined campaign filter

__failed__

__transferin_not_active__

The campaign is not set to receive leads

__failed__

__advertiser_reject__

The lead was rejected by the end advertiser

 

Sample Transaction:

POST /gateway/gateway.php HTTP/1.1

Host: www.leadshot.net

User-Agent: Mozilla/5.0

pid=xxx&oid=xxx&email=name%40domain.com&fname=name&lname=name&dob=1986%2d08%2d04&ip=xxx.xxx.xxx.xxx

 __success__

__lead_received__

 

Was this article helpful?
1 out of 1 found this helpful
Have more questions? Submit a request

Comments

Powered by Zendesk