/api/affiliate/settings

get

Get settings for an affiliate

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

loginidintegerRequired

set_groupstringOptional

prefixstringOptional

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

get

/api/affiliate/settings

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'loginid' => '3',
		'set_group' => '0'
	);

$request = array(
	'method' => 'GET',
	'path' => 'affiliate/settings',
	'data' => $data
);

/*code below is the same for (almost) every API call */

$curl = curl_init();

$url = $url.'/api/'.$request['path'];

$query = http_build_query($request['data']);

if($request['method'] == 'GET'){
	//add query string parameters to the end of the url
	$url = $url.'?'.$query;
}else{
	//send parameters as POST fields
	curl_setopt($curl, CURLOPT_POST, 1);
	curl_setopt($curl, CURLOPT_POSTFIELDS, $query);

	if($request['method'] != 'POST'){
		$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
	}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);


$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

200

success

{
  "success": true,
  "settings": [
    {
      "settingid": "1",
      "set_name": "unencoded",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "2",
      "set_name": "startpage",
      "advanced": "1",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": "",
      "custom": 0,
      "set_value": ""
    },
    {
      "settingid": "3",
      "set_name": "live_update_defaults",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "1",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "169",
      "set_name": "default_minimize_page_description",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "2",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "258",
      "set_name": "affiliate_contact1",
      "advanced": "1",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": "",
      "custom": 0,
      "set_value": ""
    },
    {
      "settingid": "259",
      "set_name": "affiliate_contact2",
      "advanced": "1",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": "",
      "custom": 0,
      "set_value": ""
    },
    {
      "settingid": "260",
      "set_name": "affiliate_contact3",
      "advanced": "1",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": "",
      "custom": 0,
      "set_value": ""
    },
    {
      "settingid": "261",
      "set_name": "affiliate_contact4",
      "advanced": "1",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": "",
      "custom": 0,
      "set_value": ""
    },
    {
      "settingid": "262",
      "set_name": "affiliate_contact5",
      "advanced": "1",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": "",
      "custom": 0,
      "set_value": ""
    },
    {
      "settingid": "266",
      "set_name": "post_member_approval_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "267",
      "set_name": "post_member_rebill_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "268",
      "set_name": "post_member_upgrade_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "269",
      "set_name": "post_member_expire_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "270",
      "set_name": "post_member_insufficient_fund_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "271",
      "set_name": "post_member_credit_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "272",
      "set_name": "post_member_chargeback_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "273",
      "set_name": "post_member_void_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "274",
      "set_name": "post_member_upgradedeny_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "275",
      "set_name": "post_member_change_details_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "276",
      "set_name": "post_member_void_reversal_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "277",
      "set_name": "post_member_credit_reversal_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "278",
      "set_name": "post_member_chargeback_reversal_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "279",
      "set_name": "post_member_insufficient_reversal_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "280",
      "set_name": "post_member_pre_approval_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "281",
      "set_name": "post_member_pre_rebill_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "282",
      "set_name": "post_member_pending_approval_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "283",
      "set_name": "post_member_pending_rebill_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "284",
      "set_name": "post_member_perminute_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "285",
      "set_name": "post_member_perminute_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "286",
      "set_name": "post_member_seconds_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "287",
      "set_name": "post_member_seconds_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "288",
      "set_name": "post_member_initial_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "289",
      "set_name": "post_member_initial_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "290",
      "set_name": "post_member_trial_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "291",
      "set_name": "post_member_trial_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "292",
      "set_name": "post_member_insufficient_funds_reversal_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "293",
      "set_name": "post_member_insufficient_funds_reversal_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "294",
      "set_name": "post_member_pending_ncr_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "295",
      "set_name": "post_member_pending_ncr_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 1,
      "custom": 0,
      "set_value": 1
    },
    {
      "settingid": "296",
      "set_name": "post_extra_vars_campaignid_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "297",
      "set_name": "post_extra_vars_programid_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "298",
      "set_name": "post_extra_vars_siteid_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "299",
      "set_name": "post_extra_vars_tourid_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "300",
      "set_name": "post_extra_vars_optionid_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "301",
      "set_name": "post_extra_vars_adtoolid_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "302",
      "set_name": "post_extra_vars_subid1_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "303",
      "set_name": "post_extra_vars_subid2_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "304",
      "set_name": "post_extra_vars_billerid_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "305",
      "set_name": "post_extra_vars_countryid_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "306",
      "set_name": "post_extra_vars_promotionalid_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "307",
      "set_name": "post_extra_vars_campaignid_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "308",
      "set_name": "post_extra_vars_programid_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "309",
      "set_name": "post_extra_vars_siteid_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "310",
      "set_name": "post_extra_vars_tourid_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "311",
      "set_name": "post_extra_vars_optionid_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "312",
      "set_name": "post_extra_vars_adtoolid_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "313",
      "set_name": "post_extra_vars_subid1_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "314",
      "set_name": "post_extra_vars_subid2_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "315",
      "set_name": "post_extra_vars_billerid_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "316",
      "set_name": "post_extra_vars_countryid_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "317",
      "set_name": "post_extra_vars_promotionalid_disallow",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "318",
      "set_name": "post_member_approval_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "319",
      "set_name": "post_member_rebill_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "320",
      "set_name": "post_member_upgrade_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "321",
      "set_name": "post_member_expire_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "322",
      "set_name": "post_member_insufficient_fund_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "323",
      "set_name": "post_member_credit_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "324",
      "set_name": "post_member_chargeback_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "325",
      "set_name": "post_member_void_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "326",
      "set_name": "post_member_upgradedeny_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "327",
      "set_name": "post_member_change_details_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "328",
      "set_name": "post_member_void_reversal_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "329",
      "set_name": "post_member_credit_reversal_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "330",
      "set_name": "post_member_chargeback_reversal_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "331",
      "set_name": "post_member_insufficient_reversal_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "332",
      "set_name": "post_member_pre_approval_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "333",
      "set_name": "post_member_pre_rebill_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "334",
      "set_name": "post_member_pending_approval_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    },
    {
      "settingid": "335",
      "set_name": "post_member_pending_rebill_allowed",
      "advanced": "0",
      "set_group": "0",
      "skin_setting_group": "0",
      "default": 0,
      "custom": 0,
      "set_value": 0
    }
  ]
}

patch

Update settings for a specific affiliate

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

loginidanyRequired

unencodedintegerOptional

startpageanyOptional

flag1integerOptional

flag2integerOptional

flag3integerOptional

flag4integerOptional

flag5integerOptional

select1anyOptional

select2anyOptional

select3anyOptional

select4anyOptional

select5anyOptional

notify_passwordintegerOptional

notify_payviaintegerOptional

notify_payvia_infointegerOptional

notify_defaultsintegerOptional

notify_detailsintegerOptional

notify_settingsintegerOptional

notify_badlinkcodeintegerOptional

notify_member_changeintegerOptional

notify_member_voidedintegerOptional

notify_member_chargebackintegerOptional

notify_member_creditedintegerOptional

notify_member_insufficientintegerOptional

notify_member_cancelledintegerOptional

notify_member_rebilledintegerOptional

notify_member_joinedintegerOptional

notify_member_pre_joinedintegerOptional

notify_member_pending_joinedintegerOptional

notify_member_pre_rebilledintegerOptional

notify_member_pending_rebilledintegerOptional

notify_member_void_reversalintegerOptional

notify_member_credit_reversalintegerOptional

notify_member_chargeback_reversalintegerOptional

notify_member_insufficient_reversalintegerOptional

email_promotionalintegerOptional

email_on_notifyintegerOptional

email_on_member_changeintegerOptional

email_on_member_voidedintegerOptional

email_on_member_chargebackintegerOptional

email_on_member_creditedintegerOptional

email_on_member_insufficientintegerOptional

email_on_member_cancelledintegerOptional

email_on_member_rebilledintegerOptional

email_on_member_joinedintegerOptional

email_on_member_pre_joinedintegerOptional

email_on_member_pending_joinedintegerOptional

email_on_member_pre_rebilledintegerOptional

email_on_member_pending_rebilledintegerOptional

email_on_member_void_reversalintegerOptional

email_on_member_credit_reversalintegerOptional

email_on_member_chargeback_reversalintegerOptional

email_on_member_insufficient_reversalintegerOptional

verify_detailsintegerOptional

verify_settingsintegerOptional

verify_defaultsintegerOptional

verify_payviaintegerOptional

verify_payvia_infointegerOptional

old_post_member_approvalanyOptional

old_post_member_rebillanyOptional

old_post_member_upgradeanyOptional

old_post_member_expireanyOptional

old_post_member_insufficient_fundanyOptional

old_post_member_creditanyOptional

old_post_member_chargebackanyOptional

old_post_member_voidanyOptional

old_post_member_upgradedenyanyOptional

old_post_member_change_detailsanyOptional

old_post_member_void_reversalanyOptional

old_post_member_credit_reversalanyOptional

old_post_member_chargeback_reversalanyOptional

old_post_member_insufficient_reversalanyOptional

old_post_member_pre_approvalanyOptional

old_post_member_pre_rebillanyOptional

old_post_member_pending_approvalanyOptional

old_post_member_pending_rebillanyOptional

default_stats_viewintegerOptional

default_stats_date_rangeintegerOptional

default_stats_orderintegerOptional

default_adtools_dump_separaterintegerOptional

default_adtools_dump_record_endintegerOptional

default_news_announcement_sectionintegerOptional

default_news_sectionintegerOptional

default_news_countintegerOptional

default_stats_breakdownintegerOptional

default_dashboard_minimize_top_leftintegerOptional

default_dashboard_minimize_key_statsintegerOptional

default_dashboard_minimize_period_statsintegerOptional

default_dashboard_period_stats_view_asintegerOptional

default_dashboard_view_as_map_fieldintegerOptional

default_stats_minimize_filtersintegerOptional

default_stats_view_asintegerOptional

default_campaigns_count_per_pageintegerOptional

default_campaigns_orderbyintegerOptional

default_codes_minimize_filtersintegerOptional

default_account_changes_count_per_pageintegerOptional

default_account_changes_orderbyintegerOptional

default_messages_count_per_pageintegerOptional

default_messages_orderbyintegerOptional

default_dashboard_minimize_bottom_leftintegerOptional

default_dashboard_minimize_bottom_middleintegerOptional

default_dashboard_top_left_box_contentsintegerOptional

default_dashboard_bottom_left_box_contentsintegerOptional

default_dashboard_bottom_middle_box_contentsintegerOptional

default_dashboard_bottom_right_box_contentsintegerOptional

default_dashboard_minimize_bottom_rightintegerOptional

default_adtools_dump_formatintegerOptional

default_dashboard_key_stats_rangeintegerOptional

default_minimize_page_descriptionintegerOptional

default_payments_orderbyintegerOptional

default_adtools_count_per_pageintegerOptional

default_adtools_orderby_integerOptional

default_adtools_orderby_1integerOptional

default_adtools_orderby_2integerOptional

default_adtools_minimize_site_selectionintegerOptional

email_on_messageintegerOptional

default_adtools_orderby_8integerOptional

default_adtools_orderby_9integerOptional

default_adtools_orderby_6integerOptional

default_adtools_orderby_5integerOptional

default_adtools_orderby_4integerOptional

default_adtools_orderby_11integerOptional

default_adtools_orderby_12integerOptional

default_adtools_orderby_7integerOptional

default_adtools_orderby_18integerOptional

default_adtools_orderby_19integerOptional

default_adtools_orderby_3integerOptional

default_adtools_orderby_14integerOptional

default_adtools_orderby_21integerOptional

default_linkcodes_dump_field_1integerOptional

default_linkcodes_dump_field_2integerOptional

default_linkcodes_dump_field_3integerOptional

default_linkcodes_dump_field_4integerOptional

default_linkcodes_dump_field_5integerOptional

default_linkcodes_dump_field_6integerOptional

default_linkcodes_dump_field_7integerOptional

default_linkcodes_dump_field_8integerOptional

default_linkcodes_dump_separaterintegerOptional

default_linkcodes_dump_record_endintegerOptional

default_linkcodes_dump_formatintegerOptional

default_adtools_2_dump_field_1integerOptional

default_adtools_2_dump_field_2integerOptional

default_adtools_2_dump_field_3integerOptional

default_adtools_2_dump_field_4integerOptional

default_adtools_2_dump_field_5integerOptional

default_adtools_2_dump_field_6integerOptional

default_adtools_2_dump_field_7integerOptional

default_adtools_2_dump_field_8integerOptional

default_adtools_5_dump_field_1integerOptional

default_adtools_5_dump_field_2integerOptional

default_adtools_5_dump_field_3integerOptional

default_adtools_5_dump_field_4integerOptional

default_adtools_5_dump_field_5integerOptional

default_adtools_5_dump_field_6integerOptional

default_adtools_5_dump_field_7integerOptional

default_adtools_5_dump_field_8integerOptional

default_adtools_14_dump_field_1integerOptional

default_adtools_14_dump_field_2integerOptional

default_adtools_14_dump_field_3integerOptional

default_adtools_14_dump_field_4integerOptional

default_adtools_14_dump_field_5integerOptional

default_adtools_14_dump_field_6integerOptional

default_adtools_14_dump_field_7integerOptional

default_adtools_14_dump_field_8integerOptional

default_adtools_1_old_dateintegerOptional

default_adtools_2_old_dateintegerOptional

default_adtools_3_old_dateintegerOptional

default_adtools_4_old_dateintegerOptional

default_adtools_5_old_dateintegerOptional

default_adtools_6_old_dateintegerOptional

default_dashboard_multichart_comparison_rangeintegerOptional

default_dashboard_multichart_traffic_fieldsanyOptional

default_dashboard_multichart_income_fieldsanyOptional

default_stats_hit_pie_fieldintegerOptional

default_stats_trans_pie_fieldintegerOptional

default_stats_income_pie_fieldintegerOptional

default_stats_hit_line_fieldanyOptional

default_stats_trans_line_fieldanyOptional

default_stats_income_line_fieldanyOptional

default_stats_map_fieldanyOptional

default_adtools_minimize_dump_formintegerOptional

default_adtools_minimize_search_formintegerOptional

default_adtools_remember_campaignintegerOptional

default_adtools_remember_searchintegerOptional

default_stats_remember_searchintegerOptional

default_adtools_12_dump_field_1integerOptional

default_adtools_12_dump_field_2integerOptional

default_adtools_12_dump_field_3integerOptional

default_adtools_12_dump_field_4integerOptional

default_adtools_12_dump_field_5integerOptional

default_adtools_12_dump_field_6integerOptional

default_adtools_12_dump_field_7integerOptional

default_adtools_12_dump_field_8integerOptional

default_videos_dump_separaterintegerOptional

default_videos_dump_record_endintegerOptional

default_videos_dump_formatintegerOptional

old_post_member_pending_ncranyOptional

affiliate_contact1anyOptional

affiliate_contact2anyOptional

affiliate_contact3anyOptional

affiliate_contact4anyOptional

affiliate_contact5anyOptional

email_on_payment_storedintegerOptional

email_on_payment_paidintegerOptional

default_gallery_builder_results_view_asintegerOptional

post_member_approval_disallowintegerOptional

post_member_rebill_disallowintegerOptional

post_member_upgrade_disallowintegerOptional

post_member_expire_disallowintegerOptional

post_member_insufficient_fund_disallowintegerOptional

post_member_credit_disallowintegerOptional

post_member_chargeback_disallowintegerOptional

post_member_void_disallowintegerOptional

post_member_upgradedeny_disallowintegerOptional

post_member_change_details_disallowintegerOptional

post_member_void_reversal_disallowintegerOptional

post_member_credit_reversal_disallowintegerOptional

post_member_chargeback_reversal_disallowintegerOptional

post_member_insufficient_reversal_disallowintegerOptional

post_member_pre_approval_disallowintegerOptional

post_member_pre_rebill_disallowintegerOptional

post_member_pending_approval_disallowintegerOptional

post_member_pending_rebill_disallowintegerOptional

post_member_perminute_allowedintegerOptional

post_member_perminute_disallowintegerOptional

post_member_seconds_allowedintegerOptional

post_member_seconds_disallowintegerOptional

post_member_initial_allowedintegerOptional

post_member_initial_disallowintegerOptional

post_member_trial_allowedintegerOptional

post_member_trial_disallowintegerOptional

post_member_insufficient_funds_reversal_allowedintegerOptional

post_member_insufficient_funds_reversal_disallowintegerOptional

post_member_pending_ncr_allowedintegerOptional

post_member_pending_ncr_disallowintegerOptional

post_extra_vars_campaignid_allowedintegerOptional

post_extra_vars_programid_allowedintegerOptional

post_extra_vars_siteid_allowedintegerOptional

post_extra_vars_tourid_allowedintegerOptional

post_extra_vars_optionid_allowedintegerOptional

post_extra_vars_adtoolid_allowedintegerOptional

post_extra_vars_subid1_allowedintegerOptional

post_extra_vars_subid2_allowedintegerOptional

post_extra_vars_billerid_allowedintegerOptional

post_extra_vars_countryid_allowedintegerOptional

post_extra_vars_promotionalid_allowedintegerOptional

post_extra_vars_campaignid_disallowintegerOptional

post_extra_vars_programid_disallowintegerOptional

post_extra_vars_siteid_disallowintegerOptional

post_extra_vars_tourid_disallowintegerOptional

post_extra_vars_optionid_disallowintegerOptional

post_extra_vars_adtoolid_disallowintegerOptional

post_extra_vars_subid1_disallowintegerOptional

post_extra_vars_subid2_disallowintegerOptional

post_extra_vars_billerid_disallowintegerOptional

post_extra_vars_countryid_disallowintegerOptional

post_extra_vars_promotionalid_disallowintegerOptional

post_member_approval_allowedintegerOptional

post_member_rebill_allowedintegerOptional

post_member_upgrade_allowedintegerOptional

post_member_expire_allowedintegerOptional

post_member_insufficient_fund_allowedintegerOptional

post_member_credit_allowedintegerOptional

post_member_chargeback_allowedintegerOptional

post_member_void_allowedintegerOptional

post_member_upgradedeny_allowedintegerOptional

post_member_change_details_allowedintegerOptional

post_member_void_reversal_allowedintegerOptional

post_member_credit_reversal_allowedintegerOptional

post_member_chargeback_reversal_allowedintegerOptional

post_member_insufficient_reversal_allowedintegerOptional

post_member_pre_approval_allowedintegerOptional

post_member_pre_rebill_allowedintegerOptional

post_member_pending_approval_allowedintegerOptional

post_member_pending_rebill_allowedintegerOptional

notify_member_conversionintegerOptional

email_on_member_conversionintegerOptional

left_sidebar_collapseintegerOptional

default_admin_areaintegerOptional

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

patch

/api/affiliate/settings

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'loginid' => '3',
		'notify_password' => 1,
		'notify_payvia' => 1,
		'notify_payvia_info' => 0,
		'notify_defaults' => 0,
		'notify_details' => 1
	);

$request = array(
	'method' => 'PATCH',
	'path' => 'affiliate/settings',
	'data' => $data
);

/*code below is the same for (almost) every API call */

$curl = curl_init();

$url = $url.'/api/'.$request['path'];

$query = http_build_query($request['data']);

if($request['method'] == 'GET'){
	//add query string parameters to the end of the url
	$url = $url.'?'.$query;
}else{
	//send parameters as POST fields
	curl_setopt($curl, CURLOPT_POST, 1);
	curl_setopt($curl, CURLOPT_POSTFIELDS, $query);

	if($request['method'] != 'POST'){
		$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
	}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);


$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

200

success

{
  "result": 5,
  "success": true
}