Set Commission Change Payouts

PATCH /offer/set_commission_change_payouts

Description	URL	Response Format	Request Method	Authentication
Sets new payout values for an existing commission change	https://domain/api/offer/set_commission_change_payouts	JSON	PATCH	HTTP headers

Parameters

Paremeters must be sent with the request body. The examples below show the parameters sent as x-www-form-urlencoded.

Name	Description	Type	Required
offerid	Id of the offer that contains the commission changes being edited	integer	yes
changeid	Id of the commission change to update. Pass 0 to update the default commission change for the offer or goal specified. Use get_commission_changes to get change ids for existing commission changes	integer	yes
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 unique click. Works with click or hybrid offers	decimal	no
flat_amount_per_conversion	Flat commission paid for every conversion. Works with cpa 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

PATCH

http://domain/api/offer/set_commission_change_payouts
changeid=0
offerid=2
goalid=54
percentage_of_customer_conversion=30

Response:

[
    {
        "result":"Success","
        "message":"changes_saved",
        "changeid":"0"
    }
]

Example Code

php

<?php
$curl = curl_init();

$url = 'http://domain/api/offer/set_commission_change_payouts';

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

$data = array(
  'offerid' => 2,
  'goalid' => 54,
  'changeid' => 0,
  'percentage_of_customer_conversion' => 30
);

curl_setopt($curl, CURLOPT_HTTPHEADER, $headers); 
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true); 
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_CUSTOMREQUEST, "PATCH");
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);
?>