Skip to main content
POST
Create a CPL campaign.
Цена рассчитывается на сервере: price_per_fan вычисляется из оффера с учётом скидки вашего уровня, поэтому вызывающая сторона её не задаёт. Рекомендуем сначала вызвать GET /cpl/orders/quote с тем же телом, чтобы заранее увидеть стоимость и возможность размещения.

Авторизации

X-API-Key
string
header
обязательно

Your API key from the Studio Dashboard

Тело

application/json
offer_id
integer
обязательно
Требуемый диапазон: x >= 1
of_account_id
integer
обязательно

Numeric id of one of your linked OF accounts.

Требуемый диапазон: x >= 1
quantity
integer
обязательно

Number of fans to deliver. Must fall inside the offer's [min_quantity, max_quantity] range.

Требуемый диапазон: x >= 1
campaign_type
enum<string>
обязательно
Доступные опции:
free,
paid,
paid_trial
approved_cpl_terms
enum<boolean>
обязательно

Must be true. Attests acceptance of the CPL placement terms for this request.

Доступные опции:
true
trial_days
enum<integer>

Required when campaign_type=paid_trial. Must be in the offer's trial_days_available set.

Доступные опции:
1,
3,
7,
14,
30,
90,
180,
360
content_channels
enum<string>[]

Optional filter. When omitted, every live channel on the model is used. When set, the order uses only the listed channels (intersected with the live ones).

Доступные опции:
lifestyle,
tiktok,
lingerie,
light_nudes,
nudes
auto_renewal
boolean
по умолчанию:false

When true, the order auto-creates a follow-up of auto_renewal_fans size on completion.

auto_renewal_fans
integer

Required when auto_renewal=true. Number of fans for the auto-renewal order; must fall inside the offer's [min_quantity, max_quantity].

Требуемый диапазон: x >= 1
auto_renewal_max_price
number<float>

Required when auto_renewal=true. Per-fan price cap for the renewal; must be ≥ the server-computed per-fan cost for the requested quantity.

Требуемый диапазон: 0 <= x <= 10000
hide_income_stats
boolean
по умолчанию:false

When true, ROMI / income on this order is hidden from the partner-facing offer detail.

Ответ

Created.

success
boolean
data
object