Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Custom Caps

Create Custom Cap

post/networks/custom/caps

Request body

network_affiliate_idinteger required

The affiliate ID.

network_offer_idinteger required

The offer ID.

namestring

The custom cap setting name.

daily_conversion_capinteger

The daily conversion cap (0 for unlimited).

weekly_conversion_capinteger

The weekly conversion cap (0 for unlimited).

monthly_conversion_capinteger

The monthly conversion cap (0 for unlimited).

global_conversion_capinteger

The global conversion cap (0 for unlimited).

daily_payout_capnumber double

The daily payout cap (0 for unlimited).

weekly_payout_capnumber double

The weekly payout cap (0 for unlimited).

monthly_payout_capnumber double

The monthly payout cap (0 for unlimited).

global_payout_capnumber double

The global payout cap (0 for unlimited).

daily_click_capinteger

The daily click cap (0 for unlimited).

weekly_click_capinteger

The weekly click cap (0 for unlimited).

monthly_click_capinteger

The monthly click cap (0 for unlimited).

global_click_capinteger

The global click cap (0 for unlimited).

daily_revenue_capnumber double

The daily revenue cap (0 for unlimited).

weekly_revenue_capnumber double

The weekly revenue cap (0 for unlimited).

monthly_revenue_capnumber double

The monthly revenue cap (0 for unlimited).

global_revenue_capnumber double

The global revenue cap (0 for unlimited).

is_soft_capboolean

Whether this is a soft cap. Hard caps (false) stop conversions once the limit is reached. Soft caps (true) allow conversions beyond the limit.

Response

network_custom_cap_setting_idinteger

Unique custom cap setting ID.

network_idinteger

Network ID.

network_affiliate_idinteger

The affiliate ID.

network_offer_idinteger

The offer ID.

namestring

The custom cap setting name.

daily_conversion_capinteger

The daily conversion cap (0 for unlimited).

weekly_conversion_capinteger

The weekly conversion cap (0 for unlimited).

monthly_conversion_capinteger

The monthly conversion cap (0 for unlimited).

global_conversion_capinteger

The global conversion cap (0 for unlimited).

daily_payout_capnumber double

The daily payout cap (0 for unlimited).

weekly_payout_capnumber double

The weekly payout cap (0 for unlimited).

monthly_payout_capnumber double

The monthly payout cap (0 for unlimited).

global_payout_capnumber double

The global payout cap (0 for unlimited).

daily_click_capinteger

The daily click cap (0 for unlimited).

weekly_click_capinteger

The weekly click cap (0 for unlimited).

monthly_click_capinteger

The monthly click cap (0 for unlimited).

global_click_capinteger

The global click cap (0 for unlimited).

daily_revenue_capnumber double

The daily revenue cap (0 for unlimited).

weekly_revenue_capnumber double

The weekly revenue cap (0 for unlimited).

monthly_revenue_capnumber double

The monthly revenue cap (0 for unlimited).

global_revenue_capnumber double

The global revenue cap (0 for unlimited).

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

is_soft_capboolean

Whether this is a soft cap (allows conversions beyond the cap limit).

Example response

{
  "network_custom_cap_setting_id": 1,
  "network_id": 1,
  "network_affiliate_id": 28,
  "network_offer_id": 33,
  "time_created": 1734455015,
  "time_saved": 1734455015
}