Skip to main content
POST
Create lead upon delivery (POST)

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json
offer_id
integer
required
affiliate_id
integer
goal_id
integer
deliver_lead
enum<string>

Not evaluated on this endpoint - deferred delivery is what it does. When the goal has an active Receive campaign with at least one active Deliver vendor, every such vendor is called before the lead is stored, and each attempt is written to the leads log as an Outgoing Lead record. The verdict comes from the last vendor in that loop: only if its answer matches its configured success reply is the lead recorded and 200 returned. Otherwise the endpoint returns 400 The Lead creation failed and no conversion is stored - but the outgoing requests have normally already gone out, so retrying the call re-sends the lead to every vendor that already accepted it. A vendor with no success reply configured never matches, so a campaign whose last vendor is in that state answers 400 for every lead it has in fact delivered. When the goal has no such campaign or vendor, or the lead ends up in the trash conversion status, no delivery is attempted at all: the lead is recorded and the endpoint answers 200.

Available options:
yes,
no
email
string
firstname
string
lastname
string
phone
string
address
string
city
string
region
string
postcode
string
country
string
vertical
string
ip
string
idfa
string
gaid
string
sub_id1
string
sub_id2
string
sub_id3
string
sub_id4
string
sub_id5
string
aff_param1
string
aff_param2
string
aff_param3
string
aff_param4
string
aff_param5
string
custom1
string
custom2
string
custom3
string
custom4
string
custom5
string
custom6
string
custom7
string
custom8
string
custom9
string
custom10
string
public_notes
string
private_notes
string
promo_code
string

Response

Lead creation result.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object