Skip to main content
POST
/
networks
/
custom
/
caps
Create Custom Cap
curl --request POST \
  --url https://api.eflow.team/v1/networks/custom/caps \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "network_affiliate_id": 28,
  "network_offer_id": 33,
  "is_soft_cap": false,
  "monthly_click_cap": 23
}
'
import requests

url = "https://api.eflow.team/v1/networks/custom/caps"

payload = {
"network_affiliate_id": 28,
"network_offer_id": 33,
"is_soft_cap": False,
"monthly_click_cap": 23
}
headers = {
"X-Eflow-Api-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {'X-Eflow-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
network_affiliate_id: 28,
network_offer_id: 33,
is_soft_cap: false,
monthly_click_cap: 23
})
};

fetch('https://api.eflow.team/v1/networks/custom/caps', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.eflow.team/v1/networks/custom/caps",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'network_affiliate_id' => 28,
'network_offer_id' => 33,
'is_soft_cap' => false,
'monthly_click_cap' => 23
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Eflow-Api-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.eflow.team/v1/networks/custom/caps"

payload := strings.NewReader("{\n \"network_affiliate_id\": 28,\n \"network_offer_id\": 33,\n \"is_soft_cap\": false,\n \"monthly_click_cap\": 23\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("X-Eflow-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.eflow.team/v1/networks/custom/caps")
.header("X-Eflow-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"network_affiliate_id\": 28,\n \"network_offer_id\": 33,\n \"is_soft_cap\": false,\n \"monthly_click_cap\": 23\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.eflow.team/v1/networks/custom/caps")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Eflow-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"network_affiliate_id\": 28,\n \"network_offer_id\": 33,\n \"is_soft_cap\": false,\n \"monthly_click_cap\": 23\n}"

response = http.request(request)
puts response.read_body
{
  "network_custom_cap_setting_id": 1,
  "network_id": 1,
  "network_affiliate_id": 28,
  "network_offer_id": 33,
  "name": "<string>",
  "daily_conversion_cap": 123,
  "weekly_conversion_cap": 123,
  "monthly_conversion_cap": 123,
  "global_conversion_cap": 123,
  "daily_payout_cap": 123,
  "weekly_payout_cap": 123,
  "monthly_payout_cap": 123,
  "global_payout_cap": 123,
  "daily_click_cap": 123,
  "weekly_click_cap": 123,
  "monthly_click_cap": 123,
  "global_click_cap": 123,
  "daily_revenue_cap": 123,
  "weekly_revenue_cap": 123,
  "monthly_revenue_cap": 123,
  "global_revenue_cap": 123,
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "is_soft_cap": true,
  "relationship": {
    "affiliate": {
      "network_affiliate_id": 123,
      "network_id": 123,
      "name": "<string>",
      "account_status": "<string>"
    },
    "offer": {
      "network_offer_id": 123,
      "network_id": 123,
      "network_advertiser_id": 123,
      "network_offer_group_id": 123,
      "name": "<string>",
      "offer_status": "<string>",
      "network_tracking_domain_id": 123,
      "visibility": "<string>",
      "currency_id": "<string>"
    }
  }
}
Create a new custom cap setting. Custom caps allow you to override the default offer caps (conversions, payouts, clicks, and revenue) for a specific affiliate.

Authorizations

X-Eflow-Api-Key
string
header
required

The Everflow API key generated from the Control Center > Security.

Body

application/json
network_affiliate_id
integer
required

The affiliate ID.

network_offer_id
integer
required

The offer ID.

name
string

The custom cap setting name.

daily_conversion_cap
integer

The daily conversion cap (0 for unlimited).

weekly_conversion_cap
integer

The weekly conversion cap (0 for unlimited).

monthly_conversion_cap
integer

The monthly conversion cap (0 for unlimited).

global_conversion_cap
integer

The global conversion cap (0 for unlimited).

daily_payout_cap
number<double>

The daily payout cap (0 for unlimited).

weekly_payout_cap
number<double>

The weekly payout cap (0 for unlimited).

monthly_payout_cap
number<double>

The monthly payout cap (0 for unlimited).

global_payout_cap
number<double>

The global payout cap (0 for unlimited).

daily_click_cap
integer

The daily click cap (0 for unlimited).

weekly_click_cap
integer

The weekly click cap (0 for unlimited).

monthly_click_cap
integer

The monthly click cap (0 for unlimited).

global_click_cap
integer

The global click cap (0 for unlimited).

daily_revenue_cap
number<double>

The daily revenue cap (0 for unlimited).

weekly_revenue_cap
number<double>

The weekly revenue cap (0 for unlimited).

monthly_revenue_cap
number<double>

The monthly revenue cap (0 for unlimited).

global_revenue_cap
number<double>

The global revenue cap (0 for unlimited).

is_soft_cap
boolean

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

200 - application/json
network_custom_cap_setting_id
integer

Unique custom cap setting ID.

Example:

1

network_id
integer

Network ID.

Example:

1

network_affiliate_id
integer

The affiliate ID.

Example:

28

network_offer_id
integer

The offer ID.

Example:

33

name
string

The custom cap setting name.

daily_conversion_cap
integer

The daily conversion cap (0 for unlimited).

weekly_conversion_cap
integer

The weekly conversion cap (0 for unlimited).

monthly_conversion_cap
integer

The monthly conversion cap (0 for unlimited).

global_conversion_cap
integer

The global conversion cap (0 for unlimited).

daily_payout_cap
number<double>

The daily payout cap (0 for unlimited).

weekly_payout_cap
number<double>

The weekly payout cap (0 for unlimited).

monthly_payout_cap
number<double>

The monthly payout cap (0 for unlimited).

global_payout_cap
number<double>

The global payout cap (0 for unlimited).

daily_click_cap
integer

The daily click cap (0 for unlimited).

weekly_click_cap
integer

The weekly click cap (0 for unlimited).

monthly_click_cap
integer

The monthly click cap (0 for unlimited).

global_click_cap
integer

The global click cap (0 for unlimited).

daily_revenue_cap
number<double>

The daily revenue cap (0 for unlimited).

weekly_revenue_cap
number<double>

The weekly revenue cap (0 for unlimited).

monthly_revenue_cap
number<double>

The monthly revenue cap (0 for unlimited).

global_revenue_cap
number<double>

The global revenue cap (0 for unlimited).

time_created
integer

Unix timestamp of creation.

Example:

1734455015

time_saved
integer

Unix timestamp of last update.

Example:

1734455015

is_soft_cap
boolean

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

relationship
object