Sign in

v1

latestOpenAPI 3.0.32026-07-2226694862.5 KB
Traffic Controls

Update Traffic Control

Update an existing traffic control. This is a full object replacement.

put/networks/trafficcontrols/{controlId}

Path parameters

controlIdinteger required

The unique traffic control ID to update.

Request body

network_traffic_control_idinteger required

The ID of the traffic control to update.

namestring required

Name of the traffic control.

status'active' | 'inactive' required

Status of the traffic control. Can be one of the following values: active or inactive.

control_type'blacklist' | 'whitelist' required

Traffic controls can be either whitelist or blacklist.

targeting_action'block' | 'fail_traffic' required

The targeting action can be either block or fail_traffic.

comparison_method'exact_match' | 'contains' | 'begins_with' | 'ends_with' | 'does_not_contain' | 'does_not_match' | 'is_empty' required

Defines how the variables will be compared.

is_apply_all_affiliatesboolean required

When this is false, the network_affiliate_ids array must be filled.

is_apply_all_offersboolean required

When this is false, the network_offer_ids or network_advertiser_ids array must be filled.

variablesstring[] required

The click variable that will be looked up and compared to the values supplied. Can be one or multiple values among: sub1, sub2, sub3, sub4, sub5, sub6, sub7, sub8, sub9, sub10, source_id, referrer, isp, ip, user_agent, country, tracking_domain.

valuesstring[] required

The values that the traffic control will filter. Limited to 3000 values when using exact_match and 100 values otherwise. Please note that when using a whitelist, all values besides the ones specified here will be blocked / sent to fail traffic.

network_offer_idsinteger[]

The offers IDs that will be affected by the traffic control (only relevant when is_apply_all_offers is set to false).

network_affiliate_idsinteger[]

The affiliate IDs that will be affected by the traffic control (only relevant when is_apply_all_affiliates is set to false).

network_advertiser_idsinteger[]

The advertiser IDs that will be affected by the traffic control (only relevant when is_apply_all_offers is set to false). All offers for the specified advertiser IDs will be affected.

date_valid_fromstring

An optional start date after which the traffic control will be enforced. Use the YYYY-MM-DD format.

date_valid_tostring

An optional end date after which the traffic control will no longer be enforced. Use the YYYY-MM-DD format.

Response

network_traffic_control_idinteger

Unique traffic control ID.

network_idinteger

Network ID.

namestring

Name of the traffic control.

status'active' | 'inactive'

Status of the traffic control.

control_type'blacklist' | 'whitelist'

Traffic controls can be either whitelist or blacklist.

targeting_action'block' | 'fail_traffic'

The targeting action.

is_apply_all_offersboolean

Whether this control applies to all offers.

is_apply_all_affiliatesboolean

Whether this control applies to all affiliates.

comparison_method'exact_match' | 'contains' | 'begins_with' | 'ends_with' | 'does_not_contain' | 'does_not_match' | 'is_empty'

Defines how the variables are compared.

variablesstring[]

The click variable that will be looked up and compared to the values supplied. Can be one or multiple values among: sub1, sub2, sub3, sub4, sub5, sub6, sub7, sub8, sub9, sub10, source_id, referrer, isp, ip, user_agent, country, tracking_domain. Note: variables and values are only populated by the Get by ID endpoint.

date_valid_fromstring

Start date for the control's validity period (YYYY-MM-DD).

date_valid_tostring

End date for the control's validity period (YYYY-MM-DD).

time_createdinteger

Unix timestamp of creation.

time_savedinteger

Unix timestamp of last update.

Example response

{
  "time_created": 1734455015,
  "time_saved": 1734455015
}