Create custom param
curl --request POST \
--url https://{domain}/api/v2/network/offers/{offer_id}/custom-params \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"status": 1,
"start_date": "2025-01-01",
"end_date": "2025-01-31",
"parameters": [
{
"name": "Sample",
"value": "string"
}
],
"affiliates": "string",
"conditions": []
}
'import requests
url = "https://{domain}/api/v2/network/offers/{offer_id}/custom-params"
payload = {
"status": 1,
"start_date": "2025-01-01",
"end_date": "2025-01-31",
"parameters": [
{
"name": "Sample",
"value": "string"
}
],
"affiliates": "string",
"conditions": []
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 1,
start_date: '2025-01-01',
end_date: '2025-01-31',
parameters: [{name: 'Sample', value: 'string'}],
affiliates: 'string',
conditions: []
})
};
fetch('https://{domain}/api/v2/network/offers/{offer_id}/custom-params', 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/offers/{offer_id}/custom-params",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'status' => 1,
'start_date' => '2025-01-01',
'end_date' => '2025-01-31',
'parameters' => [
[
'name' => 'Sample',
'value' => 'string'
]
],
'affiliates' => 'string',
'conditions' => [
]
]),
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/offers/{offer_id}/custom-params"
payload := strings.NewReader("{\n \"status\": 1,\n \"start_date\": \"2025-01-01\",\n \"end_date\": \"2025-01-31\",\n \"parameters\": [\n {\n \"name\": \"Sample\",\n \"value\": \"string\"\n }\n ],\n \"affiliates\": \"string\",\n \"conditions\": []\n}")
req, _ := http.NewRequest("POST", 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.post("https://{domain}/api/v2/network/offers/{offer_id}/custom-params")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": 1,\n \"start_date\": \"2025-01-01\",\n \"end_date\": \"2025-01-31\",\n \"parameters\": [\n {\n \"name\": \"Sample\",\n \"value\": \"string\"\n }\n ],\n \"affiliates\": \"string\",\n \"conditions\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/network/offers/{offer_id}/custom-params")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": 1,\n \"start_date\": \"2025-01-01\",\n \"end_date\": \"2025-01-31\",\n \"parameters\": [\n {\n \"name\": \"Sample\",\n \"value\": \"string\"\n }\n ],\n \"affiliates\": \"string\",\n \"conditions\": []\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>",
"info": {
"custom_param": {}
}
}{
"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": "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": {}
}
}Custom params
Create custom param
Creates a new custom parameter override for an offer.
POST
/
api
/
v2
/
network
/
offers
/
{offer_id}
/
custom-params
Create custom param
curl --request POST \
--url https://{domain}/api/v2/network/offers/{offer_id}/custom-params \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"status": 1,
"start_date": "2025-01-01",
"end_date": "2025-01-31",
"parameters": [
{
"name": "Sample",
"value": "string"
}
],
"affiliates": "string",
"conditions": []
}
'import requests
url = "https://{domain}/api/v2/network/offers/{offer_id}/custom-params"
payload = {
"status": 1,
"start_date": "2025-01-01",
"end_date": "2025-01-31",
"parameters": [
{
"name": "Sample",
"value": "string"
}
],
"affiliates": "string",
"conditions": []
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
status: 1,
start_date: '2025-01-01',
end_date: '2025-01-31',
parameters: [{name: 'Sample', value: 'string'}],
affiliates: 'string',
conditions: []
})
};
fetch('https://{domain}/api/v2/network/offers/{offer_id}/custom-params', 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/offers/{offer_id}/custom-params",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'status' => 1,
'start_date' => '2025-01-01',
'end_date' => '2025-01-31',
'parameters' => [
[
'name' => 'Sample',
'value' => 'string'
]
],
'affiliates' => 'string',
'conditions' => [
]
]),
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/offers/{offer_id}/custom-params"
payload := strings.NewReader("{\n \"status\": 1,\n \"start_date\": \"2025-01-01\",\n \"end_date\": \"2025-01-31\",\n \"parameters\": [\n {\n \"name\": \"Sample\",\n \"value\": \"string\"\n }\n ],\n \"affiliates\": \"string\",\n \"conditions\": []\n}")
req, _ := http.NewRequest("POST", 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.post("https://{domain}/api/v2/network/offers/{offer_id}/custom-params")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"status\": 1,\n \"start_date\": \"2025-01-01\",\n \"end_date\": \"2025-01-31\",\n \"parameters\": [\n {\n \"name\": \"Sample\",\n \"value\": \"string\"\n }\n ],\n \"affiliates\": \"string\",\n \"conditions\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/network/offers/{offer_id}/custom-params")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"status\": 1,\n \"start_date\": \"2025-01-01\",\n \"end_date\": \"2025-01-31\",\n \"parameters\": [\n {\n \"name\": \"Sample\",\n \"value\": \"string\"\n }\n ],\n \"affiliates\": \"string\",\n \"conditions\": []\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>",
"info": {
"custom_param": {}
}
}{
"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": "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
ApiKeyHeaderAuthApiKeyAuth
Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.
Path Parameters
Offer ID.
Body
application/json
1=active, 3=inactive.
Start date (YYYY-MM-DD format).
End date (YYYY-MM-DD format). Required — omitting causes 500.
Array of {name, value} parameter overrides.
Show child attributes
Show child attributes
Comma-separated affiliate IDs.
Conditions array.
Was this page helpful?
⌘I