Offerit REST API Set Commission Change Payouts
From Offerit
Revision as of 16:29, 12 May 2017 by Offeritnick (talk | contribs)
PATCH /offer/set_commission_change_payouts
Description
- set_commission_change_payouts sets new payout values for an existing commission change
Resource URL
- http://domain/api/offer/set_commission_change_payouts
- Replace domain with the Offerit domain
Response Format
- 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
- offerid
- type: int
- required
- Id of the offer that contains the commission changes being edited.
- changeid
- type: int
- required
- 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
- goalid
- type: int
- 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
- flat_amount_per_click
- type: decimal'
- Flat commission paid for every raw click. Works with click or hybrid offers
- flat_amount_per_visitor
- type: decimal'
- Flat commission paid for every unique click. Works with click or hybrid offers
- flat_amount_per_conversion
- type: decimal'
- Flat commission paid for every conversion. Works with cpa or hybrid offers
- flat_amount_per_continuity
- type: decimal'
- Flat commission paid for every continuity. Works with cpa or hybrid offers
- percentage_of_customer_conversion
- type: decimal'
- Percentage of conversion revenue to pay as commission. Works with cps or hybrid offers
- percentage_of_customer_continuity
- type: decimal'
- Percentage of continuity revenue to pay as commission. Works with cps or hybrid offers
- aff_manager_payout
- type: bool'
- Only applies to goal changes. Specifies if events posted to this goal should trigger affiliate manager payouts if applicable.
- aff_referral_payout
- type: bool'
- Only applies to goal changes. Specifies if events posted to this goal should trigger affiliate referral payouts if applicable.
- offer_partner_payout
- type: bool'
- Only applies to goal changes. Specifies if events posted to this goal should trigger offer partner payouts if applicable.
- type: bool'
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);
?>
