Skip to content

Add Commission Change

POST /offer/add_commission_change

Description URL Response Format Request Method Authentication
Add a new offer https://domain/api/offer/add_commission_change JSON POST HTTP headers

Parameters

Name Description Type Required
offerid Id of the offer that contains the commission changes being edited integer yes
type Disable automatically sets all payout fields to 0. Temporary lets you set a start and end date to schedule when the payout change will be in effect. Standard is everything else. Options are: string yes
standard no
disable no
temporary no
username Username of affiliate to restrict this new commission change to string no
loginid Loginid of affiliate to restrict this new commission change to integer no
countries Array of 2 character iso2 country codes to restrict this new commission change to array no
subaff Optional affiliate subaff value to restrict this new commission change to string no
subaff2 Optional affiliate subaff2 value to restrict this new commission change to string no
subaff3 Optional affiliate subaff3 value to restrict this new commission change to string no
subaff4 Optional affiliate subaff4 value to restrict this new commission change to string no
subaff5 Optional affiliate subaff5 value to restrict this new commission change to string no
start_time Start time for type=temporary. String to time is run on this field. string no
end_time End time for type=temporary. String to time is run on this field. string no
goalid The offer goal id visible in the edit offer details page or from get_commission_changes. Default 0 updates the main offer commission changes instead of goal specific commissions integer no
flat_amount_per_click Flat commission paid for every raw click. Works with click or hybrid offers decimal no
flat_amount_per_visitor Flat commission paid for every raw click. Works with click or hybrid offers decimal no
flat_amount_per_conversion Flat commission paid for every raw click. Works with click or hybrid offers decimal no
flat_amount_per_continuity Flat commission paid for every continuity. Works with cpa or hybrid offers decimal no
percentage_of_customer_conversion Percentage of conversion revenue to pay as commission. Works with cps or hybrid offers decimal no
percentage_of_customer_continuity Percentage of continuity revenue to pay as commission. Works with cps or hybrid offers decimal no
aff_manager_payout Only applies to goal changes. Specifies if events posted to this goal should trigger affiliate manager payouts if applicable. boolean no
aff_referral_payout Only applies to goal changes. Specifies if events posted to this goal should trigger affiliate referral payouts if applicable. boolean no
offer_partner_payout Only applies to goal changes. Specifies if events posted to this goal should trigger offer partner payouts if applicable. boolean no

Example Request

POST

http://domain/api/offer/add_commission_change
loginid=2
offerid=2
type=standard
countries[0] = GB
countries[1] = DE
flat_amount_per_conversion=15
flat_amount_per_continuity=5

Response:

{
    "result":"Success",
    "message": 'changes_saved',
    "changeid": 59
}

Example Code

php

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

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

 $data = Array(
    'offerid' => 2,
    'loginid' => 2,
    'type' => 'standard',
    'countries' => Array('GB,DE'),
    'flat_amount_per_conversion' => 15,
    'flat_amount_per_continuity' => 5,
); 

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($curl, CURLOPT_POSTFIELDS, http_build_query($data));

$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); 
?>