Create a campaign
curl --request POST \
--url https://api.referralful.com/v1/campaigns \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"commission_percent": 123,
"commission_amount_cents": 123,
"days_before_referrals_expire": 123,
"minimum_payout_cents": 123,
"max_commission_period_in_months": 123
}
'import requests
url = "https://api.referralful.com/v1/campaigns"
payload = {
"name": "<string>",
"url": "<string>",
"commission_percent": 123,
"commission_amount_cents": 123,
"days_before_referrals_expire": 123,
"minimum_payout_cents": 123,
"max_commission_period_in_months": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
commission_percent: 123,
commission_amount_cents: 123,
days_before_referrals_expire: 123,
minimum_payout_cents: 123,
max_commission_period_in_months: 123
})
};
fetch('https://api.referralful.com/v1/campaigns', 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://api.referralful.com/v1/campaigns",
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([
'name' => '<string>',
'url' => '<string>',
'commission_percent' => 123,
'commission_amount_cents' => 123,
'days_before_referrals_expire' => 123,
'minimum_payout_cents' => 123,
'max_commission_period_in_months' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://api.referralful.com/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"commission_percent\": 123,\n \"commission_amount_cents\": 123,\n \"days_before_referrals_expire\": 123,\n \"minimum_payout_cents\": 123,\n \"max_commission_period_in_months\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://api.referralful.com/v1/campaigns")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"commission_percent\": 123,\n \"commission_amount_cents\": 123,\n \"days_before_referrals_expire\": 123,\n \"minimum_payout_cents\": 123,\n \"max_commission_period_in_months\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.referralful.com/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"commission_percent\": 123,\n \"commission_amount_cents\": 123,\n \"days_before_referrals_expire\": 123,\n \"minimum_payout_cents\": 123,\n \"max_commission_period_in_months\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "campaign",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"url": "<string>",
"private": true,
"commission_percent": 123,
"commission_amount_cents": 123,
"commission_currency": "<string>",
"minimum_payout_cents": 123,
"days_before_referrals_expire": 123,
"days_before_commissions_are_due": 123,
"max_commissions": 123,
"max_commission_period_in_months": 123
}API Reference
Create a campaign
POST
/
campaigns
Create a campaign
curl --request POST \
--url https://api.referralful.com/v1/campaigns \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"url": "<string>",
"commission_percent": 123,
"commission_amount_cents": 123,
"days_before_referrals_expire": 123,
"minimum_payout_cents": 123,
"max_commission_period_in_months": 123
}
'import requests
url = "https://api.referralful.com/v1/campaigns"
payload = {
"name": "<string>",
"url": "<string>",
"commission_percent": 123,
"commission_amount_cents": 123,
"days_before_referrals_expire": 123,
"minimum_payout_cents": 123,
"max_commission_period_in_months": 123
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
url: '<string>',
commission_percent: 123,
commission_amount_cents: 123,
days_before_referrals_expire: 123,
minimum_payout_cents: 123,
max_commission_period_in_months: 123
})
};
fetch('https://api.referralful.com/v1/campaigns', 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://api.referralful.com/v1/campaigns",
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([
'name' => '<string>',
'url' => '<string>',
'commission_percent' => 123,
'commission_amount_cents' => 123,
'days_before_referrals_expire' => 123,
'minimum_payout_cents' => 123,
'max_commission_period_in_months' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$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://api.referralful.com/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"commission_percent\": 123,\n \"commission_amount_cents\": 123,\n \"days_before_referrals_expire\": 123,\n \"minimum_payout_cents\": 123,\n \"max_commission_period_in_months\": 123\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
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://api.referralful.com/v1/campaigns")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"commission_percent\": 123,\n \"commission_amount_cents\": 123,\n \"days_before_referrals_expire\": 123,\n \"minimum_payout_cents\": 123,\n \"max_commission_period_in_months\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.referralful.com/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"url\": \"<string>\",\n \"commission_percent\": 123,\n \"commission_amount_cents\": 123,\n \"days_before_referrals_expire\": 123,\n \"minimum_payout_cents\": 123,\n \"max_commission_period_in_months\": 123\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"object": "campaign",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"name": "<string>",
"url": "<string>",
"private": true,
"commission_percent": 123,
"commission_amount_cents": 123,
"commission_currency": "<string>",
"minimum_payout_cents": 123,
"days_before_referrals_expire": 123,
"days_before_commissions_are_due": 123,
"max_commissions": 123,
"max_commission_period_in_months": 123
}Authorizations
Use your API secret as the username, with an empty password.
Body
application/json
Response
201 - application/json
Created
Example:
"campaign"
Available options:
percent, amount ⌘I
