Skip to main content
POST
Create lead by click ID (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
aff_click_id
string
required

Affiliate click ID.

click_id
string

Click UUID.

goal_id
integer
offer_id
integer
revenue
number

Revenue amount for this conversion.

payout
number

Affiliate payout amount.

amount
number

Sale amount.

conv_status
enum<string>
Available options:
pending,
approved,
rejected,
hold
adv_order_id
string

Advertiser order identifier.

adv_user_id
string

Advertiser user identifier.

adv_track_id
string

Advertiser tracking ID.

email
string

Lead email address.

firstname
string

Lead first name.

lastname
string

Lead last name.

phone
string

Lead phone number.

gender
enum<string>

Lead gender: m=male, f=female.

Available options:
m,
f
birthday
string<date>

Lead date of birth (YYYY-MM-DD).

address
string

Lead street address.

city
string

Lead city.

region
string

Lead region/state.

postcode
string

Lead postal/ZIP code.

country
string

Lead country code.

vertical
string

Industry vertical identifier.

ip
string

Visitor IP address.

idfa
string

iOS advertising identifier.

gaid
string

Google advertising identifier.

Deep link URL.

sub_id1
string

Affiliate sub ID 1.

sub_id2
string

Affiliate sub ID 2.

sub_id3
string

Affiliate sub ID 3.

sub_id4
string

Affiliate sub ID 4.

sub_id5
string

Affiliate sub ID 5.

aff_param1
string

Custom affiliate parameter 1.

aff_param2
string

Custom affiliate parameter 2.

aff_param3
string

Custom affiliate parameter 3.

aff_param4
string

Custom affiliate parameter 4.

aff_param5
string

Custom affiliate parameter 5.

adv_param1
string

Custom advertiser parameter 1.

adv_param2
string

Custom advertiser parameter 2.

adv_param3
string

Custom advertiser parameter 3.

adv_param4
string

Custom advertiser parameter 4.

adv_param5
string

Custom advertiser parameter 5.

custom1
string

Custom data field 1.

custom2
string

Custom data field 2.

custom3
string

Custom data field 3.

custom4
string

Custom data field 4.

custom5
string

Custom data field 5.

custom6
string

Custom data field 6.

custom7
string

Custom data field 7.

custom8
string

Custom data field 8.

custom9
string

Custom data field 9.

custom10
string

Custom data field 10.

public_notes
string

Note visible to the affiliate.

private_notes
string

Internal note, not visible to the affiliate.

deliver_lead
enum<string>
default:no

Forwards the created lead to the external systems configured for its goal. With yes the lead is posted out; with no (the default) it is only recorded in Scaleo. Delivery needs the Leads Management Module, an active Receive campaign bound to the lead's goal_id, and at least one active Deliver vendor on that campaign - without them, or when a vendor's posting instructions are empty, yes has no effect. Each vendor is called with its own posting instructions (URL, method, headers, tokenized body); its answer is matched against the vendor's success reply and sets the lead's delivery status - success, fail, or empty when the vendor has no success reply configured. Every attempt is stored in the leads log as an Outgoing Lead record. Leads that end up in the trash conversion status (failed campaign validation, geo check, or cap) are never delivered. If the vendor has "return reply" enabled, its raw response is added to the response payload as delivery_reply.

Available options:
yes,
no
timestamp
string

Conversion timestamp (YYYY-MM-DD HH:MM:SS).

currency
string

Currency code.

promo_code
string

Promo code used by the lead.

click_referer_url
string

Click referrer URL.

conversion_referer_url
string

Conversion referrer URL.

Response

Lead creation result.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object