Skip to main content
PATCH
/
api
/
v2
/
network
/
assign-commission-plan
Assign commission plan (PATCH)
curl --request PATCH \
  --url https://{domain}/api/v2/network/assign-commission-plan \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "commission_plan_id": 1,
  "affiliate_ids": [
    1
  ]
}
'
import requests

url = "https://{domain}/api/v2/network/assign-commission-plan"

payload = {
"commission_plan_id": 1,
"affiliate_ids": [1]
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'PATCH',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({commission_plan_id: 1, affiliate_ids: [1]})
};

fetch('https://{domain}/api/v2/network/assign-commission-plan', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/network/assign-commission-plan",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'commission_plan_id' => 1,
'affiliate_ids' => [
1
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://{domain}/api/v2/network/assign-commission-plan"

payload := strings.NewReader("{\n \"commission_plan_id\": 1,\n \"affiliate_ids\": [\n 1\n ]\n}")

req, _ := http.NewRequest("PATCH", url, payload)

req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.patch("https://{domain}/api/v2/network/assign-commission-plan")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"commission_plan_id\": 1,\n \"affiliate_ids\": [\n 1\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/network/assign-commission-plan")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"commission_plan_id\": 1,\n \"affiliate_ids\": [\n 1\n ]\n}"

response = http.request(request)
puts response.read_body
{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "<string>"
}
{
"message": "Request could not be parsed.",
"success": false,
"info": {
"errors": {}
}
}
{
"message": "API key is invalid or missing.",
"success": false
}
{
"message": "This endpoint is not available for your role.",
"success": false
}
{
"message": "Resource not found.",
"success": false
}
{
"message": "Validation error",
"success": false,
"info": {
"errors": {
"email": [
"Email cannot be blank."
],
"currency": [
"Currency must be a valid ISO code."
]
}
}
}
{
"message": "An unexpected error occurred.",
"success": false,
"info": {
"errors": {}
}
}

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json
commission_plan_id
integer

ID of the commission plan to assign.

affiliate_ids
integer[]

Affiliate IDs to assign the commission plan to.

Response

Commission plan assigned.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string