Skip to main content
POST
/
cpl
/
orders
/
{public_id}
/
settings
Update CPL order settings.
curl --request POST \
  --url https://studio-api.onlytraffic.com/api/external/v1/cpl/orders/{public_id}/settings \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "auto_renewal": true,
  "hide_income_stats": true,
  "auto_renewal_fans": 2,
  "auto_renewal_max_price": 5000
}
'
{
  "success": true,
  "data": {
    "order_id": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://onlytraffic.com/docs/llms.txt

Use this file to discover all available pages before exploring further.

Mutates auto_renewal_* and hide_income_stats on a waiting or accepted order. Auto-renewal is re-priced against the offer at submit time: auto_renewal_max_price must cover the per-fan cost for the requested quantity, otherwise the request is rejected.

Authorizations

​
X-API-Key
string
header
required

Your API key from the Studio Dashboard

Path Parameters

​
public_id
string
required

Resource public id. Format varies by endpoint: cplo_xxxxxxx for CPL orders, cpco_xxxxxxx for CPC orders, swpo_xxxxxxx for swap orders, cpcr_xxxxxxx for CPC creatives, revi_xxxxxxx for RevShare invoices.

Pattern: ^[a-z0-9_]+$

Body

application/json
​
auto_renewal
boolean
required

When true, on completion the order auto-creates a follow-up of the same shape.

​
hide_income_stats
boolean
required

When true, this order's income/ROMI is hidden from the partner offer page.

​
auto_renewal_fans
integer

Required when auto_renewal=true. Must fall inside the offer's [min_quantity, max_quantity] window.

Required range: x >= 1
​
auto_renewal_max_price
number<float>

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

Required range: 0 <= x <= 10000

Response

Updated.

​
success
boolean
​
data
object