Update Smart Link

PUT /networks/campaigns/{campaignId}

Update Smart Link

cURL

curl --request PUT \
  --url https://api.eflow.team/v1/networks/campaigns/{campaignId} \
  --header 'Content-Type: application/json' \
  --header 'X-Eflow-Api-Key: <api-key>' \
  --data '
{
  "campaign_status": "active",
  "redirect_routing_type": "priority",
  "campaign_name": "My Smart Link",
  "catch_all_network_offer_id": 1,
  "network_tracking_domain_id": 1,
  "is_use_secure_link": false,
  "is_open_to_affiliates": true,
  "redirects": [
    {
      "redirect_network_offer_id": 1,
      "redirect_network_offer_url_id": 0,
      "routing_value": 1
    }
  ]
}
'

200

{
  "network_campaign_id": 1,
  "network_id": 1,
  "campaign_name": "My Smart Link",
  "campaign_status": "active",
  "network_tracking_domain_id": 1,
  "is_use_secure_link": false,
  "redirect_routing_type": "weight",
  "catch_all_network_offer_id": 57,
  "is_open_to_affiliates": false,
  "run_frequency": "unknown",
  "metric": "unknown",
  "optimization_goal": 0,
  "data_lookback_window": "unknown",
  "data_collection_threshold": 0,
  "time_created": 1734455015,
  "time_saved": 1734455015,
  "relationship": {
    "redirects": {
      "total": 123,
      "entries": [
        {
          "network_campaign_redirect_id": 6,
          "network_campaign_id": 1,
          "redirect_network_offer_id": 11,
          "redirect_network_offer_url_id": 0,
          "routing_value": 1,
          "ruleset": {}
        }
      ]
    },
    "labels": {
      "total": 123,
      "entries": [
        "<string>"
      ]
    },
    "catch_all_offer_basic": {
      "network_offer_id": 123,
      "network_id": 123,
      "name": "<string>",
      "offer_status": "<string>"
    },
    "encoded_value": "<string>"
  }
}

Update an existing smart link (campaign). Any omitted non-required fields will be reset to defaults.

Authorizations

X-Eflow-Api-Key · string · header · required

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

Path Parameters

campaignId · integer · required

The smart link (campaign) identifier.

Body

application/json

campaign_name · string · required

The displayed name of the smart link.

campaign_status · enum<string> · required

Status of the smart link.

Available options: active, paused, deleted

network_tracking_domain_id · integer · required

The ID of the domain to be used in the affiliate tracking link.

is_use_secure_link · boolean · required

Whether to force SSL. Improves tracking and security by setting tracking links to always use HTTPS instead of HTTP.

redirect_routing_type · enum<string> · required

The redirect mechanism of the campaign. Determines how the Smart Link traffic is distributed between the listed offers. KPI automatically delivers traffic ranked by the best performing offers for your set KPI. Priority checks the first position and continues downward if the user doesn't match targeting/cap. Weight delivers traffic with a percentage split between eligible offers.

Available options: priority, weight, kpi

is_open_to_affiliates · boolean · required

Whether to make the campaign visible to affiliates. If enabled, the Smart Link will be visible to the partner only if all the offers are runnable by the partner.

redirects · object[] · required

Show child attributes

labels · string[] · required

Labels to associate with the smart link.

catch_all_network_offer_id · integer

The ID of the offer to use as the catch-all offer. The Catch-All Offer will be considered only if the partner has access to the offer and the click can't be matched with any of the offers in the redirect tree.

run_frequency · enum<string>

Determines how often your offers are re-ranked based on the best performing offers towards your KPI. Required if redirect_routing_type is set to kpi.

Available options: unknown, 12_hours, 24_hours, 6_hours, 3_hours, 1_hours

metric · enum<string>

The metric used with the KPI campaign. The highest performing offers for your selected metric will be re-ranked towards receiving the majority of the Smart Link traffic. Required if redirect_routing_type is set to kpi.

Available options: unknown, profit, cvr, evr, conversions, payout, revenue, rpc, cpc, epc

optimization_goal · number

Optimizes ranking towards the offers that are closest to your set Specific Goal. Required if redirect_routing_type is set to kpi.

data_lookback_window · enum<string>

Determines the period of data used for evaluating how offers are performing at your set Metric. Can be 12_hours, 24_hours, or 48_hours. Required if redirect_routing_type is set to kpi.

Available options: unknown, 12_hours, 24_hours, 48_hours

data_collection_threshold · integer

The amount of data required before the KPI-based Smart Link starts determining the initial rankings for the best performing offers. Required if redirect_routing_type is set to kpi.

conversion_method · enum<string>

Conversion tracking method for the smart link.

Available options: server_postback, pixel_tracking

is_whitelist_check_enabled · boolean

Whether to enforce whitelist checking for affiliates on this smart link.

Response

200 - application/json

network_campaign_id · integer

Unique smart link (campaign) ID.

Example:

1

network_id · integer

Network ID.

Example:

1

campaign_name · string

The displayed name of the smart link.

Example:

"My Smart Link"

campaign_status · enum<string>

Status of the smart link.

Available options: active, paused, deleted

Example:

"active"

network_tracking_domain_id · integer

The ID of the domain used in the affiliate tracking link.

Example:

1

is_use_secure_link · boolean

Whether SSL is forced on tracking links.

Example:

false

redirect_routing_type · enum<string>

Determines how the Smart Link traffic is distributed between the listed offers. kpi automatically delivers traffic ranked by the best performing offers for your set KPI. priority checks the first position and continues downward if the user doesn't match targeting/cap. weight delivers traffic with a percentage split between eligible offers.

Available options: priority, weight, kpi

Example:

"weight"

catch_all_network_offer_id · integer

The ID of the offer to use as the catch-all offer. The Catch-All Offer will be considered only if the partner has access to the offer and the click can't be matched with any of the offers in the redirect tree.

Example:

57

is_open_to_affiliates · boolean

Whether the smart link is visible to affiliates. If enabled, the Smart Link will be visible to the partner only if all the offers in the redirect tree are runnable by the partner.

Example:

false

run_frequency · enum<string>

Determines how often your offers are re-ranked based on the best performing offers towards your KPI. Required if redirect_routing_type is set to kpi.

Available options: unknown, 1_hours, 3_hours, 6_hours, 12_hours, 24_hours

Example:

"unknown"

metric · enum<string>

The metric used with the KPI campaign. The highest performing offers for your selected metric will be re-ranked towards receiving the majority of the Smart Link traffic. Required if redirect_routing_type is set to kpi.

Available options: unknown, profit, cvr, evr, conversions, payout, revenue, rpc, cpc, epc

Example:

"unknown"

optimization_goal · number

Optimizes ranking towards the offers that are closest to your set Specific Goal. Required if redirect_routing_type is set to kpi.

Example:

0

data_lookback_window · enum<string>

Determines the period of data used for evaluating how offers are performing at your set Metric. Can be 12_hours, 24_hours, or 48_hours. Required if redirect_routing_type is set to kpi.

Available options: unknown, 12_hours, 24_hours, 48_hours

Example:

"unknown"

data_collection_threshold · integer

The amount of data (in clicks) required before the KPI-based Smart Link starts determining the initial rankings for the best performing offers. Required if redirect_routing_type is set to kpi.

Example:

0

time_created · integer

Unix timestamp of creation.

Example:

1734455015

time_saved · integer

Unix timestamp of last update.

Example:

1734455015

relationship · object

Show child attributes