Skip to content

Set Enabled Affiliates

PATCH /offer/set_enabled_affiliates

Description URL Response Format Request Method Authentication
Enable or disable affiliates for multiple offers or landing pages https://domain/api/offer/set_enabled_affiliates JSON PATCH HTTP headers

Parameters

Name Description Type Required
action Enable or disable the specified affiliates on the specified landing pages. Revert clears the existing enable/disable value and uses the landing page public/private setting. OR Set the specified affiliates to enabled / disabled for requesting the specified landing pages. Revert clears the existing enable/disable value and uses the landing page public/private setting. integer yes
Options:
enable
disable
revert
enable_requestable
revert_requestable
loginids Optionally specify which affiliates to modify integer no
all_users Optionally modify all affiliates boolean no
offerids Optionally specify which offerids to modify. Will affect all landing pages in offer. integer no
landing_pageids Optionally specify which landing_pageids to modify integer no
advertiser_ids Optionally specify that you want to modify all landing pages of all offers owned by these advertisers integer no
offer_name_like Optionally specify which offerids to modify. Will affect all landing pages in offer. string no
landing_page_name_like Optionally specify that you want to modify all landing pages like the name sent. string no
all_landers Optionally modify all landing pages boolean no

Note

Either loginids or all_users should be present in every request.

Note

Parameters loginids, offerids, landing_pageids, advertiser_ids can be int, array of ints, comma separated list of ints.

Note

If multiple settings are used specifying which landing pages to modify, they are evaluated in the following order: - all_landers - landing_pageids - offerids - advertiser_ids + offer_name_like + landing_page_name_like + url_like

Example Request

PATCH

http://domain/api/offer/set_enabled_affiliates
action=enable
offerids=1
all_users=true

http://domain/api/offer/set_enabled_affiliates
action=revert
url_like=example.com
offer_name_like=someoffer
loginids=1,2,3,4

Response:

{
  "result":"Success",
  "message":"Access modified"
}

Example Code

php

<?php 
$url = 'http://domain/api/offer/set_enabled_affiliates';
$curl = curl_init(); 

$headers = array( 
    'api-key: 44b5498dbcb481a0d00b404c0169af62', 
    'api-username: productsupport' 
);

 $data = Array(
  'action' => 'enable'
  'offerids' => 1,
  'all_users' => TRUE,
); 

curl_setopt($curl, CURLOPT_PATCH, 1);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_PATCHFIELDS, http_build_query($data));
curl_setopt($curl, CURLOPT_URL, $url); 


$resp = curl_exec($curl); 
//dumps an associative array representation of the json response
$output = json_decode($resp, true);
if($output !== NULL) {
    //json was valid. Dump the decoded array
    print_r($output);
}
else {
    //invalid json, just dump the raw response
    print_r($resp);
}
// Close request to clear up some resources 
curl_close($curl); 
?>