NATS For Networks REST Set Enabled Affiliates
From TMM Wiki
Jump to navigationJump to searchThe printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.
PATCH /offer/set_enabled_affiliates
Description
- get_creative_rule adds a new creative rule
Resource URL
- http://domain/api/offer/set_enabled_affiliates
- Replace domain with the NATS For Networks domain
Response Format
- JSON
- PATCH
- HTTP headers
Parameters
- action
- type: string
- required
- Options: enable,disable,revert,enable_requestable,disable_requestable,revert_requestable
- 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.
- loginids
- type: int, array of ints, comma separated list of ints
- Optionally specify which affiliates to modify.
- all_users
- type: bool
- Optionally modify all affiliates
Either loginids or all_users should be present in every request.
- offerids
- type: int, array of ints, comma separated list of ints
- Optionally specify which offerids to modify. Will affect all landing pages in offer.
- landing_pageids
- type: int, array of ints, comma separated list of ints
- Optionally specify which landing_pageids to modify.
- advertiser_ids
- type: int, array of ints, comma separated list of ints
- Optionally specify that you want to modify all landing pages of all offers owned by these advertisers.
- offer_name_like
- type: string
- Optionally specify that you want to modify all landing pages of all offers like the name sent.
- landing_page_name_like
- type: string
- Optionally specify that you want to modify all landing pages like the name sent.
- url_like
- type: string
- Optionally specify that you want to modify all landing pages like the url sent.
- all_landers
- type: bool
- Optionally modify all landing pages
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); ?>