Skip to main content
POST
Create conversion by offer ID

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

Offer ID.

affiliate_id
integer

Affiliate ID. If omitted, the default affiliate for the offer is used.

revenue
number
payout
number
amount
number
conv_status
enum<string>

Initial conversion status.

Available options:
pending,
approved,
rejected,
hold
adv_order_id
string

Advertiser order ID.

adv_user_id
string

Advertiser user ID.

email
string
firstname
string
lastname
string
phone
string
custom1
string
custom2
string
custom3
string
custom4
string
custom5
string
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

Response

Conversion created.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object