Create a campaign
curl --request POST \
--url https://go.affixo.dev/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cookie_window_days": 60,
"attribution_model": "last_click",
"status": "active",
"auto_approve": true,
"auto_enrol": true,
"enrol_existing": false,
"make_default": false,
"destination_url": "<string>",
"additional_referral_links": [
"<string>"
],
"ref_param": "<string>"
}
'import requests
url = "https://go.affixo.dev/v1/campaigns"
payload = {
"name": "<string>",
"cookie_window_days": 60,
"attribution_model": "last_click",
"status": "active",
"auto_approve": True,
"auto_enrol": True,
"enrol_existing": False,
"make_default": False,
"destination_url": "<string>",
"additional_referral_links": ["<string>"],
"ref_param": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cookie_window_days: 60,
attribution_model: 'last_click',
status: 'active',
auto_approve: true,
auto_enrol: true,
enrol_existing: false,
make_default: false,
destination_url: '<string>',
additional_referral_links: ['<string>'],
ref_param: '<string>'
})
};
fetch('https://go.affixo.dev/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://go.affixo.dev/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>',
'cookie_window_days' => 60,
'attribution_model' => 'last_click',
'status' => 'active',
'auto_approve' => true,
'auto_enrol' => true,
'enrol_existing' => false,
'make_default' => false,
'destination_url' => '<string>',
'additional_referral_links' => [
'<string>'
],
'ref_param' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://go.affixo.dev/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cookie_window_days\": 60,\n \"attribution_model\": \"last_click\",\n \"status\": \"active\",\n \"auto_approve\": true,\n \"auto_enrol\": true,\n \"enrol_existing\": false,\n \"make_default\": false,\n \"destination_url\": \"<string>\",\n \"additional_referral_links\": [\n \"<string>\"\n ],\n \"ref_param\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://go.affixo.dev/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cookie_window_days\": 60,\n \"attribution_model\": \"last_click\",\n \"status\": \"active\",\n \"auto_approve\": true,\n \"auto_enrol\": true,\n \"enrol_existing\": false,\n \"make_default\": false,\n \"destination_url\": \"<string>\",\n \"additional_referral_links\": [\n \"<string>\"\n ],\n \"ref_param\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://go.affixo.dev/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cookie_window_days\": 60,\n \"attribution_model\": \"last_click\",\n \"status\": \"active\",\n \"auto_approve\": true,\n \"auto_enrol\": true,\n \"enrol_existing\": false,\n \"make_default\": false,\n \"destination_url\": \"<string>\",\n \"additional_referral_links\": [\n \"<string>\"\n ],\n \"ref_param\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"object": "campaign",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"cookie_window_days": 60,
"attribution_model": "last_click",
"destination_url": "<string>",
"additional_referral_links": [
"<string>"
],
"ref_param": "<string>",
"is_default": true,
"join_mode": "anyone",
"auto_approve": true,
"auto_enrol": true,
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": "invalid_json"
}{
"error": "unauthorized"
}{
"error": "insufficient_scope",
"need": "write"
}Campaigns
Create a campaign
Requires write (or *) scope.
POST
/
v1
/
campaigns
Create a campaign
curl --request POST \
--url https://go.affixo.dev/v1/campaigns \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"cookie_window_days": 60,
"attribution_model": "last_click",
"status": "active",
"auto_approve": true,
"auto_enrol": true,
"enrol_existing": false,
"make_default": false,
"destination_url": "<string>",
"additional_referral_links": [
"<string>"
],
"ref_param": "<string>"
}
'import requests
url = "https://go.affixo.dev/v1/campaigns"
payload = {
"name": "<string>",
"cookie_window_days": 60,
"attribution_model": "last_click",
"status": "active",
"auto_approve": True,
"auto_enrol": True,
"enrol_existing": False,
"make_default": False,
"destination_url": "<string>",
"additional_referral_links": ["<string>"],
"ref_param": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
cookie_window_days: 60,
attribution_model: 'last_click',
status: 'active',
auto_approve: true,
auto_enrol: true,
enrol_existing: false,
make_default: false,
destination_url: '<string>',
additional_referral_links: ['<string>'],
ref_param: '<string>'
})
};
fetch('https://go.affixo.dev/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://go.affixo.dev/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>',
'cookie_window_days' => 60,
'attribution_model' => 'last_click',
'status' => 'active',
'auto_approve' => true,
'auto_enrol' => true,
'enrol_existing' => false,
'make_default' => false,
'destination_url' => '<string>',
'additional_referral_links' => [
'<string>'
],
'ref_param' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"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://go.affixo.dev/v1/campaigns"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"cookie_window_days\": 60,\n \"attribution_model\": \"last_click\",\n \"status\": \"active\",\n \"auto_approve\": true,\n \"auto_enrol\": true,\n \"enrol_existing\": false,\n \"make_default\": false,\n \"destination_url\": \"<string>\",\n \"additional_referral_links\": [\n \"<string>\"\n ],\n \"ref_param\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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://go.affixo.dev/v1/campaigns")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"cookie_window_days\": 60,\n \"attribution_model\": \"last_click\",\n \"status\": \"active\",\n \"auto_approve\": true,\n \"auto_enrol\": true,\n \"enrol_existing\": false,\n \"make_default\": false,\n \"destination_url\": \"<string>\",\n \"additional_referral_links\": [\n \"<string>\"\n ],\n \"ref_param\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://go.affixo.dev/v1/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"cookie_window_days\": 60,\n \"attribution_model\": \"last_click\",\n \"status\": \"active\",\n \"auto_approve\": true,\n \"auto_enrol\": true,\n \"enrol_existing\": false,\n \"make_default\": false,\n \"destination_url\": \"<string>\",\n \"additional_referral_links\": [\n \"<string>\"\n ],\n \"ref_param\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"object": "campaign",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "active",
"cookie_window_days": 60,
"attribution_model": "last_click",
"destination_url": "<string>",
"additional_referral_links": [
"<string>"
],
"ref_param": "<string>",
"is_default": true,
"join_mode": "anyone",
"auto_approve": true,
"auto_enrol": true,
"created_at": "2023-11-07T05:31:56Z"
}
}{
"error": "invalid_json"
}{
"error": "unauthorized"
}{
"error": "insufficient_scope",
"need": "write"
}Authorizations
Body
application/json
Who can join. anyone makes a membership active right away; approve means you approve each request; invite hides the campaign from affiliates outside it, who can't join or ask. You add people yourself, or auto_enrol adds them, and they're active. The default campaign can't be invite only. Wins over auto_approve when both are sent.
Available options:
anyone, approve, invite Who can join. true lets anyone join; false means you approve each new affiliate. It decides signups while this is the default campaign, which is where new signups land, and on any campaign it decides whether an affiliate added automatically (auto_enrol) is active right away or waits for your approval. Omit to leave it unset (anyone).