Programs and partners
PUT
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/payout-schedule PUT /v1/programs/{id}/payout-schedule
Parameters
idstringpathrequiredRequest body application/json
scheduleobjectrequired{
"schedule": {
"kind": null,
"dayOfMonth": null
}
}Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/payout-schedule" \
-H "Content-Type: application/json" \
-d '{"schedule":{"kind":null,"dayOfMonth":null}}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/payout-schedule', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"schedule":{"kind":null,"dayOfMonth":null}}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PUT",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/payout-schedule",
headers={
"Content-Type": "application/json",
},
json={"schedule": {"kind": None, "dayOfMonth": None}},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/payout-schedule", strings.NewReader(`{"schedule":{"kind":null,"dayOfMonth":null}}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/payout-schedule');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"schedule":{"kind":null,"dayOfMonth":null}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/payout-schedule')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"schedule":{"kind":null,"dayOfMonth":null}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/payout-schedule"))
.header("Content-Type", "application/json")
.method("PUT", BodyPublishers.ofString("{\"schedule\":{\"kind\":null,\"dayOfMonth\":null}}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"programId": "string",
"schedule": {
"kind": null,
"dayOfMonth": null
},
"nextRunDate": "string"
}Schema
programIdstringrequiredschedulePayoutSchedule | objectrequirednextRunDatestringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
PUT
https://referally.15.204.158.166.sslip.io /v1/partners/{id}/vat PUT /v1/partners/{id}/vat
Parameters
idstringpathrequiredRequest body application/json
vatIdstringrequired{
"vatId": "string"
}Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/vat" \
-H "Content-Type: application/json" \
-d '{"vatId":"string"}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/vat', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"vatId":"string"}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PUT",
"https://referally.15.204.158.166.sslip.io/v1/partners/{id}/vat",
headers={
"Content-Type": "application/json",
},
json={"vatId": "string"},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/vat", strings.NewReader(`{"vatId":"string"}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}/vat');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"vatId":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/vat')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"vatId":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}/vat"))
.header("Content-Type", "application/json")
.method("PUT", BodyPublishers.ofString("{\"vatId\":\"string\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"vatId": "string",
"vatCountry": "string",
"vatVerifiedAt": "2024-01-01T00:00:00Z",
"selfBillingAcceptedAt": "2024-01-01T00:00:00Z",
"selfBillingVersion": "string"
}Schema
vatIdstringrequiredvatCountrystringrequiredvatVerifiedAtstringrequiredselfBillingAcceptedAtstringrequiredselfBillingVersionstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/programs List programs
Code samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/programs"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/programs",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/programs", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
"object": "string",
"data": [
{
"id": "string",
"name": "string",
"slug": "string",
"attributionModel": "last_click",
"cookieWindowDays": 0,
"signupToConversionDays": 0,
"termsMd": "string",
"status": "draft",
"publicHandle": "string",
"settings": {
"probabilisticPolicy": "string",
"selfReferralPolicy": "review",
"splitCommissions": true,
"utmTemplate": {},
"allowPaidSearch": true,
"challengeLinks": true,
"settlement": "payout",
"riskPolicy": {
"holdBotScore": null,
"holdDisposableEmail": null,
"holdVelocity": null,
"holdUnverifiedEmail": null,
"holdSelfReferral": null,
"holdRiskScore": null,
"holdHighRiskLevel": null
},
"widget": {
"autoEnroll": null,
"destinationUrl": null
},
"refereeReward": null
},
"publicPage": {
"pitch": "string",
"autoApprove": true
},
"createdAt": "2024-01-01T00:00:00Z"
}
],
"has_more": true,
"next_cursor": "string"
}Schema
objectstringrequireddataProgram[]requiredShow child parameters
idstringrequirednamestringrequiredslugstringrequiredattributionModelstringrequiredcookieWindowDaysintegerrequiredsignupToConversionDaysintegerrequiredtermsMdstringrequiredstatusstringrequiredpublicHandlestringrequiredsettingsobjectrequiredShow child parameters
probabilisticPolicystringrequiredselfReferralPolicystringrequiredsplitCommissionsbooleanrequiredutmTemplateobjectrequiredallowPaidSearchbooleanrequiredchallengeLinksbooleanrequiredsettlementstringrequiredriskPolicyobjectrequiredwidgetobjectrequiredrefereeRewardGetOpenapiJsonResponsepublicPageobjectrequiredShow child parameters
pitchstringrequiredautoApprovebooleanrequiredcreatedAtstringrequiredhas_morebooleanrequiredWhether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/programs Create a program
Request body application/json
namestringrequiredslugstringrequiredattributionModelstringcookieWindowDaysintegersignupToConversionDaysintegertermsMdstringstatusstringpublicHandlestringpublicPageobjectShow child parameters
pitchstringautoApprovebooleanprobabilisticPolicystringselfReferralPolicystringsplitCommissionsbooleanutmTemplateobjectallowPaidSearchbooleanchallengeLinksbooleansettlementstringriskPolicyobjectShow child parameters
holdBotScorenumberholdRiskScorenumberholdHighRiskLevelbooleanholdDisposableEmailbooleanholdVelocityintegerholdUnverifiedEmailbooleanholdSelfReferralbooleanwidgetobjectShow child parameters
autoEnrollbooleandestinationUrlstring{
"name": "string",
"slug": "string",
"attributionModel": "last_click",
"cookieWindowDays": 60,
"signupToConversionDays": 365,
"termsMd": "",
"status": "draft",
"publicHandle": "string",
"publicPage": {
"pitch": "string",
"autoApprove": true
},
"probabilisticPolicy": "auto",
"selfReferralPolicy": "review",
"splitCommissions": true,
"utmTemplate": {},
"allowPaidSearch": true,
"challengeLinks": true,
"settlement": "payout",
"riskPolicy": {
"holdBotScore": 0,
"holdRiskScore": 0,
"holdHighRiskLevel": true,
"holdDisposableEmail": true,
"holdVelocity": 0,
"holdUnverifiedEmail": true,
"holdSelfReferral": true
},
"widget": {
"autoEnroll": true,
"destinationUrl": "string"
}
}Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/programs" \
-H "Content-Type: application/json" \
-d '{"name":"string","slug":"string","attributionModel":"last_click","cookieWindowDays":60,"signupToConversionDays":365,"termsMd":"","status":"draft","publicHandle":"string","publicPage":{"pitch":"string","autoApprove":true},"probabilisticPolicy":"auto","selfReferralPolicy":"review","splitCommissions":true,"utmTemplate":{},"allowPaidSearch":true,"challengeLinks":true,"settlement":"payout","riskPolicy":{"holdBotScore":0,"holdRiskScore":0,"holdHighRiskLevel":true,"holdDisposableEmail":true,"holdVelocity":0,"holdUnverifiedEmail":true,"holdSelfReferral":true},"widget":{"autoEnroll":true,"destinationUrl":"string"}}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"name":"string","slug":"string","attributionModel":"last_click","cookieWindowDays":60,"signupToConversionDays":365,"termsMd":"","status":"draft","publicHandle":"string","publicPage":{"pitch":"string","autoApprove":true},"probabilisticPolicy":"auto","selfReferralPolicy":"review","splitCommissions":true,"utmTemplate":{},"allowPaidSearch":true,"challengeLinks":true,"settlement":"payout","riskPolicy":{"holdBotScore":0,"holdRiskScore":0,"holdHighRiskLevel":true,"holdDisposableEmail":true,"holdVelocity":0,"holdUnverifiedEmail":true,"holdSelfReferral":true},"widget":{"autoEnroll":true,"destinationUrl":"string"}}),
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/programs",
headers={
"Content-Type": "application/json",
},
json={"name": "string", "slug": "string", "attributionModel": "last_click", "cookieWindowDays": 60, "signupToConversionDays": 365, "termsMd": "", "status": "draft", "publicHandle": "string", "publicPage": {"pitch": "string", "autoApprove": True}, "probabilisticPolicy": "auto", "selfReferralPolicy": "review", "splitCommissions": True, "utmTemplate": {}, "allowPaidSearch": True, "challengeLinks": True, "settlement": "payout", "riskPolicy": {"holdBotScore": 0, "holdRiskScore": 0, "holdHighRiskLevel": True, "holdDisposableEmail": True, "holdVelocity": 0, "holdUnverifiedEmail": True, "holdSelfReferral": True}, "widget": {"autoEnroll": True, "destinationUrl": "string"}},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/programs", strings.NewReader(`{"name":"string","slug":"string","attributionModel":"last_click","cookieWindowDays":60,"signupToConversionDays":365,"termsMd":"","status":"draft","publicHandle":"string","publicPage":{"pitch":"string","autoApprove":true},"probabilisticPolicy":"auto","selfReferralPolicy":"review","splitCommissions":true,"utmTemplate":{},"allowPaidSearch":true,"challengeLinks":true,"settlement":"payout","riskPolicy":{"holdBotScore":0,"holdRiskScore":0,"holdHighRiskLevel":true,"holdDisposableEmail":true,"holdVelocity":0,"holdUnverifiedEmail":true,"holdSelfReferral":true},"widget":{"autoEnroll":true,"destinationUrl":"string"}}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","slug":"string","attributionModel":"last_click","cookieWindowDays":60,"signupToConversionDays":365,"termsMd":"","status":"draft","publicHandle":"string","publicPage":{"pitch":"string","autoApprove":true},"probabilisticPolicy":"auto","selfReferralPolicy":"review","splitCommissions":true,"utmTemplate":{},"allowPaidSearch":true,"challengeLinks":true,"settlement":"payout","riskPolicy":{"holdBotScore":0,"holdRiskScore":0,"holdHighRiskLevel":true,"holdDisposableEmail":true,"holdVelocity":0,"holdUnverifiedEmail":true,"holdSelfReferral":true},"widget":{"autoEnroll":true,"destinationUrl":"string"}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","slug":"string","attributionModel":"last_click","cookieWindowDays":60,"signupToConversionDays":365,"termsMd":"","status":"draft","publicHandle":"string","publicPage":{"pitch":"string","autoApprove":true},"probabilisticPolicy":"auto","selfReferralPolicy":"review","splitCommissions":true,"utmTemplate":{},"allowPaidSearch":true,"challengeLinks":true,"settlement":"payout","riskPolicy":{"holdBotScore":0,"holdRiskScore":0,"holdHighRiskLevel":true,"holdDisposableEmail":true,"holdVelocity":0,"holdUnverifiedEmail":true,"holdSelfReferral":true},"widget":{"autoEnroll":true,"destinationUrl":"string"}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs"))
.header("Content-Type", "application/json")
.method("POST", BodyPublishers.ofString("{\"name\":\"string\",\"slug\":\"string\",\"attributionModel\":\"last_click\",\"cookieWindowDays\":60,\"signupToConversionDays\":365,\"termsMd\":\"\",\"status\":\"draft\",\"publicHandle\":\"string\",\"publicPage\":{\"pitch\":\"string\",\"autoApprove\":true},\"probabilisticPolicy\":\"auto\",\"selfReferralPolicy\":\"review\",\"splitCommissions\":true,\"utmTemplate\":{},\"allowPaidSearch\":true,\"challengeLinks\":true,\"settlement\":\"payout\",\"riskPolicy\":{\"holdBotScore\":0,\"holdRiskScore\":0,\"holdHighRiskLevel\":true,\"holdDisposableEmail\":true,\"holdVelocity\":0,\"holdUnverifiedEmail\":true,\"holdSelfReferral\":true},\"widget\":{\"autoEnroll\":true,\"destinationUrl\":\"string\"}}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"name": "string",
"slug": "string",
"attributionModel": "last_click",
"cookieWindowDays": 0,
"signupToConversionDays": 0,
"termsMd": "string",
"status": "draft",
"publicHandle": "string",
"settings": {
"probabilisticPolicy": "string",
"selfReferralPolicy": "review",
"splitCommissions": true,
"utmTemplate": {},
"allowPaidSearch": true,
"challengeLinks": true,
"settlement": "payout",
"riskPolicy": {
"holdBotScore": 0,
"holdDisposableEmail": true,
"holdVelocity": 0,
"holdUnverifiedEmail": true,
"holdSelfReferral": true,
"holdRiskScore": 0,
"holdHighRiskLevel": true
},
"widget": {
"autoEnroll": true,
"destinationUrl": "string"
},
"refereeReward": {}
},
"publicPage": {
"pitch": "string",
"autoApprove": true
},
"createdAt": "2024-01-01T00:00:00Z"
}Schema
idstringrequirednamestringrequiredslugstringrequiredattributionModelstringrequiredcookieWindowDaysintegerrequiredsignupToConversionDaysintegerrequiredtermsMdstringrequiredstatusstringrequiredpublicHandlestringrequiredsettingsobjectrequiredShow child parameters
probabilisticPolicystringrequiredselfReferralPolicystringrequiredsplitCommissionsbooleanrequiredutmTemplateobjectrequiredallowPaidSearchbooleanrequiredchallengeLinksbooleanrequiredsettlementstringrequiredriskPolicyobjectrequiredShow child parameters
holdBotScorenumberrequiredholdDisposableEmailbooleanrequiredholdVelocityintegerrequiredholdUnverifiedEmailbooleanrequiredholdSelfReferralbooleanrequiredholdRiskScorenumberrequiredholdHighRiskLevelbooleanrequiredwidgetobjectrequiredShow child parameters
autoEnrollbooleanrequireddestinationUrlstringrequiredrefereeRewardGetOpenapiJsonResponsepublicPageobjectrequiredShow child parameters
pitchstringrequiredautoApprovebooleanrequiredcreatedAtstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/programs/{id} GET /v1/programs/{id}
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/programs/{id}"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"name": "string",
"slug": "string",
"attributionModel": "last_click",
"cookieWindowDays": 0,
"signupToConversionDays": 0,
"termsMd": "string",
"status": "draft",
"publicHandle": "string",
"settings": {
"probabilisticPolicy": "string",
"selfReferralPolicy": "review",
"splitCommissions": true,
"utmTemplate": {},
"allowPaidSearch": true,
"challengeLinks": true,
"settlement": "payout",
"riskPolicy": {
"holdBotScore": 0,
"holdDisposableEmail": true,
"holdVelocity": 0,
"holdUnverifiedEmail": true,
"holdSelfReferral": true,
"holdRiskScore": 0,
"holdHighRiskLevel": true
},
"widget": {
"autoEnroll": true,
"destinationUrl": "string"
},
"refereeReward": {}
},
"publicPage": {
"pitch": "string",
"autoApprove": true
},
"createdAt": "2024-01-01T00:00:00Z"
}Schema
idstringrequirednamestringrequiredslugstringrequiredattributionModelstringrequiredcookieWindowDaysintegerrequiredsignupToConversionDaysintegerrequiredtermsMdstringrequiredstatusstringrequiredpublicHandlestringrequiredsettingsobjectrequiredShow child parameters
probabilisticPolicystringrequiredselfReferralPolicystringrequiredsplitCommissionsbooleanrequiredutmTemplateobjectrequiredallowPaidSearchbooleanrequiredchallengeLinksbooleanrequiredsettlementstringrequiredriskPolicyobjectrequiredShow child parameters
holdBotScorenumberrequiredholdDisposableEmailbooleanrequiredholdVelocityintegerrequiredholdUnverifiedEmailbooleanrequiredholdSelfReferralbooleanrequiredholdRiskScorenumberrequiredholdHighRiskLevelbooleanrequiredwidgetobjectrequiredShow child parameters
autoEnrollbooleanrequireddestinationUrlstringrequiredrefereeRewardGetOpenapiJsonResponsepublicPageobjectrequiredShow child parameters
pitchstringrequiredautoApprovebooleanrequiredcreatedAtstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
PATCH
https://referally.15.204.158.166.sslip.io /v1/programs/{id} PATCH /v1/programs/{id}
Parameters
idstringpathrequiredRequest body application/json
namestringslugstringattributionModelstringcookieWindowDaysintegersignupToConversionDaysintegertermsMdstringstatusstringpublicHandlestringpublicPageobjectShow child parameters
pitchstringautoApprovebooleanprobabilisticPolicystringselfReferralPolicystringsplitCommissionsbooleanutmTemplateobjectallowPaidSearchbooleanchallengeLinksbooleansettlementstringriskPolicyobjectShow child parameters
holdBotScorenumberholdRiskScorenumberholdHighRiskLevelbooleanholdDisposableEmailbooleanholdVelocityintegerholdUnverifiedEmailbooleanholdSelfReferralbooleanwidgetobjectShow child parameters
autoEnrollbooleandestinationUrlstring{
"name": "string",
"slug": "string",
"attributionModel": "last_click",
"cookieWindowDays": 0,
"signupToConversionDays": 0,
"termsMd": "string",
"status": "draft",
"publicHandle": "string",
"publicPage": {
"pitch": "string",
"autoApprove": true
},
"probabilisticPolicy": "auto",
"selfReferralPolicy": "review",
"splitCommissions": true,
"utmTemplate": {},
"allowPaidSearch": true,
"challengeLinks": true,
"settlement": "payout",
"riskPolicy": {
"holdBotScore": 0,
"holdRiskScore": 0,
"holdHighRiskLevel": true,
"holdDisposableEmail": true,
"holdVelocity": 0,
"holdUnverifiedEmail": true,
"holdSelfReferral": true
},
"widget": {
"autoEnroll": true,
"destinationUrl": "string"
}
}Code samples
cURL
curl -X PATCH "https://referally.15.204.158.166.sslip.io/v1/programs/{id}" \
-H "Content-Type: application/json" \
-d '{"name":"string","slug":"string","attributionModel":"last_click","cookieWindowDays":0,"signupToConversionDays":0,"termsMd":"string","status":"draft","publicHandle":"string","publicPage":{"pitch":"string","autoApprove":true},"probabilisticPolicy":"auto","selfReferralPolicy":"review","splitCommissions":true,"utmTemplate":{},"allowPaidSearch":true,"challengeLinks":true,"settlement":"payout","riskPolicy":{"holdBotScore":0,"holdRiskScore":0,"holdHighRiskLevel":true,"holdDisposableEmail":true,"holdVelocity":0,"holdUnverifiedEmail":true,"holdSelfReferral":true},"widget":{"autoEnroll":true,"destinationUrl":"string"}}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}', {
method: 'PATCH',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"name":"string","slug":"string","attributionModel":"last_click","cookieWindowDays":0,"signupToConversionDays":0,"termsMd":"string","status":"draft","publicHandle":"string","publicPage":{"pitch":"string","autoApprove":true},"probabilisticPolicy":"auto","selfReferralPolicy":"review","splitCommissions":true,"utmTemplate":{},"allowPaidSearch":true,"challengeLinks":true,"settlement":"payout","riskPolicy":{"holdBotScore":0,"holdRiskScore":0,"holdHighRiskLevel":true,"holdDisposableEmail":true,"holdVelocity":0,"holdUnverifiedEmail":true,"holdSelfReferral":true},"widget":{"autoEnroll":true,"destinationUrl":"string"}}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PATCH",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}",
headers={
"Content-Type": "application/json",
},
json={"name": "string", "slug": "string", "attributionModel": "last_click", "cookieWindowDays": 0, "signupToConversionDays": 0, "termsMd": "string", "status": "draft", "publicHandle": "string", "publicPage": {"pitch": "string", "autoApprove": True}, "probabilisticPolicy": "auto", "selfReferralPolicy": "review", "splitCommissions": True, "utmTemplate": {}, "allowPaidSearch": True, "challengeLinks": True, "settlement": "payout", "riskPolicy": {"holdBotScore": 0, "holdRiskScore": 0, "holdHighRiskLevel": True, "holdDisposableEmail": True, "holdVelocity": 0, "holdUnverifiedEmail": True, "holdSelfReferral": True}, "widget": {"autoEnroll": True, "destinationUrl": "string"}},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PATCH", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}", strings.NewReader(`{"name":"string","slug":"string","attributionModel":"last_click","cookieWindowDays":0,"signupToConversionDays":0,"termsMd":"string","status":"draft","publicHandle":"string","publicPage":{"pitch":"string","autoApprove":true},"probabilisticPolicy":"auto","selfReferralPolicy":"review","splitCommissions":true,"utmTemplate":{},"allowPaidSearch":true,"challengeLinks":true,"settlement":"payout","riskPolicy":{"holdBotScore":0,"holdRiskScore":0,"holdHighRiskLevel":true,"holdDisposableEmail":true,"holdVelocity":0,"holdUnverifiedEmail":true,"holdSelfReferral":true},"widget":{"autoEnroll":true,"destinationUrl":"string"}}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","slug":"string","attributionModel":"last_click","cookieWindowDays":0,"signupToConversionDays":0,"termsMd":"string","status":"draft","publicHandle":"string","publicPage":{"pitch":"string","autoApprove":true},"probabilisticPolicy":"auto","selfReferralPolicy":"review","splitCommissions":true,"utmTemplate":{},"allowPaidSearch":true,"challengeLinks":true,"settlement":"payout","riskPolicy":{"holdBotScore":0,"holdRiskScore":0,"holdHighRiskLevel":true,"holdDisposableEmail":true,"holdVelocity":0,"holdUnverifiedEmail":true,"holdSelfReferral":true},"widget":{"autoEnroll":true,"destinationUrl":"string"}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}')
req = Net::HTTP::Patch.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","slug":"string","attributionModel":"last_click","cookieWindowDays":0,"signupToConversionDays":0,"termsMd":"string","status":"draft","publicHandle":"string","publicPage":{"pitch":"string","autoApprove":true},"probabilisticPolicy":"auto","selfReferralPolicy":"review","splitCommissions":true,"utmTemplate":{},"allowPaidSearch":true,"challengeLinks":true,"settlement":"payout","riskPolicy":{"holdBotScore":0,"holdRiskScore":0,"holdHighRiskLevel":true,"holdDisposableEmail":true,"holdVelocity":0,"holdUnverifiedEmail":true,"holdSelfReferral":true},"widget":{"autoEnroll":true,"destinationUrl":"string"}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}"))
.header("Content-Type", "application/json")
.method("PATCH", BodyPublishers.ofString("{\"name\":\"string\",\"slug\":\"string\",\"attributionModel\":\"last_click\",\"cookieWindowDays\":0,\"signupToConversionDays\":0,\"termsMd\":\"string\",\"status\":\"draft\",\"publicHandle\":\"string\",\"publicPage\":{\"pitch\":\"string\",\"autoApprove\":true},\"probabilisticPolicy\":\"auto\",\"selfReferralPolicy\":\"review\",\"splitCommissions\":true,\"utmTemplate\":{},\"allowPaidSearch\":true,\"challengeLinks\":true,\"settlement\":\"payout\",\"riskPolicy\":{\"holdBotScore\":0,\"holdRiskScore\":0,\"holdHighRiskLevel\":true,\"holdDisposableEmail\":true,\"holdVelocity\":0,\"holdUnverifiedEmail\":true,\"holdSelfReferral\":true},\"widget\":{\"autoEnroll\":true,\"destinationUrl\":\"string\"}}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"name": "string",
"slug": "string",
"attributionModel": "last_click",
"cookieWindowDays": 0,
"signupToConversionDays": 0,
"termsMd": "string",
"status": "draft",
"publicHandle": "string",
"settings": {
"probabilisticPolicy": "string",
"selfReferralPolicy": "review",
"splitCommissions": true,
"utmTemplate": {},
"allowPaidSearch": true,
"challengeLinks": true,
"settlement": "payout",
"riskPolicy": {
"holdBotScore": 0,
"holdDisposableEmail": true,
"holdVelocity": 0,
"holdUnverifiedEmail": true,
"holdSelfReferral": true,
"holdRiskScore": 0,
"holdHighRiskLevel": true
},
"widget": {
"autoEnroll": true,
"destinationUrl": "string"
},
"refereeReward": {}
},
"publicPage": {
"pitch": "string",
"autoApprove": true
},
"createdAt": "2024-01-01T00:00:00Z"
}Schema
idstringrequirednamestringrequiredslugstringrequiredattributionModelstringrequiredcookieWindowDaysintegerrequiredsignupToConversionDaysintegerrequiredtermsMdstringrequiredstatusstringrequiredpublicHandlestringrequiredsettingsobjectrequiredShow child parameters
probabilisticPolicystringrequiredselfReferralPolicystringrequiredsplitCommissionsbooleanrequiredutmTemplateobjectrequiredallowPaidSearchbooleanrequiredchallengeLinksbooleanrequiredsettlementstringrequiredriskPolicyobjectrequiredShow child parameters
holdBotScorenumberrequiredholdDisposableEmailbooleanrequiredholdVelocityintegerrequiredholdUnverifiedEmailbooleanrequiredholdSelfReferralbooleanrequiredholdRiskScorenumberrequiredholdHighRiskLevelbooleanrequiredwidgetobjectrequiredShow child parameters
autoEnrollbooleanrequireddestinationUrlstringrequiredrefereeRewardGetOpenapiJsonResponsepublicPageobjectrequiredShow child parameters
pitchstringrequiredautoApprovebooleanrequiredcreatedAtstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/enrollments GET /v1/programs/{id}/enrollments
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
"object": "string",
"data": [
{
"id": "string",
"partnerId": "string",
"partnerEmail": "string",
"partnerName": "string",
"status": "string",
"createdAt": "2024-01-01T00:00:00Z",
"networkWarning": {
"flagged": true,
"reason": null,
"bannedByOtherMerchants": 0
}
}
],
"has_more": true,
"next_cursor": "string"
}Schema
objectstringrequireddataobject[]requiredShow child parameters
idstringrequiredpartnerIdstringrequiredpartnerEmailstringrequiredpartnerNamestringrequiredstatusstringrequiredcreatedAtstringrequirednetworkWarningobjectrequiredShow child parameters
flaggedbooleanrequiredreasonstringrequiredbannedByOtherMerchantsintegerrequiredOther merchants that banned this account; 0 below the threshold (2). Never says which.
has_morebooleanrequiredWhether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/enrollments Enroll a partner
Parameters
idstringpathrequiredRequest body application/json
partnerIdstringrequired{
"partnerId": "string"
}Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments" \
-H "Content-Type: application/json" \
-d '{"partnerId":"string"}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"partnerId":"string"}),
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments",
headers={
"Content-Type": "application/json",
},
json={"partnerId": "string"},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments", strings.NewReader(`{"partnerId":"string"}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"partnerId":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"partnerId":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments"))
.header("Content-Type", "application/json")
.method("POST", BodyPublishers.ofString("{\"partnerId\":\"string\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"programId": "string",
"partnerId": "string",
"status": "applied"
}Schema
idstringrequiredprogramIdstringrequiredpartnerIdstringrequiredstatusstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/enrollments/{enrollmentId}/approve POST /v1/programs/{id}/enrollments/{enrollmentId}/approve
Parameters
idstringpathrequiredenrollmentIdstringpathrequiredCode samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/approve"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/approve', {
method: 'POST',
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/approve",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/approve", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/approve');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/approve')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/approve"))
.method("POST", BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"status": "string"
}Schema
idstringrequiredstatusstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/enrollments/{enrollmentId}/reject POST /v1/programs/{id}/enrollments/{enrollmentId}/reject
Parameters
idstringpathrequiredenrollmentIdstringpathrequiredCode samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/reject"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/reject', {
method: 'POST',
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/reject",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/reject", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/reject');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/reject')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/enrollments/{enrollmentId}/reject"))
.method("POST", BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"status": "string"
}Schema
idstringrequiredstatusstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/partners GET /v1/partners
Parameters
emailstringqueryexternalRefstringquerystatusstringqueryincludeArchivedstringqueryCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/partners?email=&externalRef=&status=&includeArchived="TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners?email=&externalRef=&status=&includeArchived=', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/partners?email=&externalRef=&status=&includeArchived=",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/partners?email=&externalRef=&status=&includeArchived=", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners?email=&externalRef=&status=&includeArchived=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners?email=&externalRef=&status=&includeArchived=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners?email=&externalRef=&status=&includeArchived="))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
"object": "string",
"data": [
{
"id": "string",
"email": "string",
"displayName": "string",
"externalRef": "string",
"status": "active",
"tags": [
"string"
],
"notes": "string",
"createdAt": "2024-01-01T00:00:00Z"
}
],
"has_more": true,
"next_cursor": "string"
}Schema
objectstringrequireddataPartner[]requiredShow child parameters
idstringrequiredemailstringrequireddisplayNamestringrequiredexternalRefstringrequiredstatusstringrequiredtagsstring[]requirednotesstringrequiredcreatedAtstringrequiredhas_morebooleanrequiredWhether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/partners Create a partner
Request body application/json
emailstringrequireddisplayNamestringtagsstring[]notesstringexternalRefstringupsertboolean{
"email": "string",
"displayName": "",
"tags": [],
"notes": "",
"externalRef": "string",
"upsert": false
}Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/partners" \
-H "Content-Type: application/json" \
-d '{"email":"string","displayName":"","tags":[],"notes":"","externalRef":"string","upsert":false}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"email":"string","displayName":"","tags":[],"notes":"","externalRef":"string","upsert":false}),
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/partners",
headers={
"Content-Type": "application/json",
},
json={"email": "string", "displayName": "", "tags": [], "notes": "", "externalRef": "string", "upsert": False},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/partners", strings.NewReader(`{"email":"string","displayName":"","tags":[],"notes":"","externalRef":"string","upsert":false}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"email":"string","displayName":"","tags":[],"notes":"","externalRef":"string","upsert":false}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"email":"string","displayName":"","tags":[],"notes":"","externalRef":"string","upsert":false}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners"))
.header("Content-Type", "application/json")
.method("POST", BodyPublishers.ofString("{\"email\":\"string\",\"displayName\":\"\",\"tags\":[],\"notes\":\"\",\"externalRef\":\"string\",\"upsert\":false}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"email": "string",
"displayName": "string",
"externalRef": "string",
"status": "active",
"tags": [
"string"
],
"notes": "string",
"createdAt": "2024-01-01T00:00:00Z"
}Schema
idstringrequiredemailstringrequireddisplayNamestringrequiredexternalRefstringrequiredstatusstringrequiredtagsstring[]requirednotesstringrequiredcreatedAtstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/partners/{id} GET /v1/partners/{id}
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/partners/{id}"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/partners/{id}",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"email": "string",
"displayName": "string",
"externalRef": "string",
"status": "active",
"tags": [
"string"
],
"notes": "string",
"createdAt": "2024-01-01T00:00:00Z",
"networkWarning": {
"flagged": true,
"reason": "platform_flagged",
"bannedByOtherMerchants": 0
}
}Schema
idstringrequiredemailstringrequireddisplayNamestringrequiredexternalRefstringrequiredstatusstringrequiredtagsstring[]requirednotesstringrequiredcreatedAtstringrequirednetworkWarningobjectrequiredShow child parameters
flaggedbooleanrequiredreasonstringrequiredbannedByOtherMerchantsintegerrequiredOther merchants that banned this account; 0 below the threshold (2). Never says which.
default Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
DELETE
https://referally.15.204.158.166.sslip.io /v1/partners/{id} DELETE /v1/partners/{id}
Parameters
idstringpathrequiredCode samples
cURL
curl -X DELETE "https://referally.15.204.158.166.sslip.io/v1/partners/{id}"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}', {
method: 'DELETE',
});
const data = await res.json();Python
import requests
res = requests.request(
"DELETE",
"https://referally.15.204.158.166.sslip.io/v1/partners/{id}",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("DELETE", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}')
req = Net::HTTP::Delete.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}"))
.method("DELETE", BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"ok": true
}Schema
okbooleanrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
PATCH
https://referally.15.204.158.166.sslip.io /v1/partners/{id} PATCH /v1/partners/{id}
Parameters
idstringpathrequiredRequest body application/json
displayNamestringstatusstringtagsstring[]notesstringexternalRefstring{
"displayName": "string",
"status": "active",
"tags": [
"string"
],
"notes": "string",
"externalRef": "string"
}Code samples
cURL
curl -X PATCH "https://referally.15.204.158.166.sslip.io/v1/partners/{id}" \
-H "Content-Type: application/json" \
-d '{"displayName":"string","status":"active","tags":["string"],"notes":"string","externalRef":"string"}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}', {
method: 'PATCH',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"displayName":"string","status":"active","tags":["string"],"notes":"string","externalRef":"string"}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PATCH",
"https://referally.15.204.158.166.sslip.io/v1/partners/{id}",
headers={
"Content-Type": "application/json",
},
json={"displayName": "string", "status": "active", "tags": ["string"], "notes": "string", "externalRef": "string"},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PATCH", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}", strings.NewReader(`{"displayName":"string","status":"active","tags":["string"],"notes":"string","externalRef":"string"}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"displayName":"string","status":"active","tags":["string"],"notes":"string","externalRef":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}')
req = Net::HTTP::Patch.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"displayName":"string","status":"active","tags":["string"],"notes":"string","externalRef":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}"))
.header("Content-Type", "application/json")
.method("PATCH", BodyPublishers.ofString("{\"displayName\":\"string\",\"status\":\"active\",\"tags\":[\"string\"],\"notes\":\"string\",\"externalRef\":\"string\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"email": "string",
"displayName": "string",
"externalRef": "string",
"status": "active",
"tags": [
"string"
],
"notes": "string",
"createdAt": "2024-01-01T00:00:00Z"
}Schema
idstringrequiredemailstringrequireddisplayNamestringrequiredexternalRefstringrequiredstatusstringrequiredtagsstring[]requirednotesstringrequiredcreatedAtstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/partners/{id}/enrollments GET /v1/partners/{id}/enrollments
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/enrollments"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/enrollments', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/partners/{id}/enrollments",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/enrollments", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}/enrollments');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/enrollments')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}/enrollments"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
"object": "string",
"data": [
{
"id": "string",
"programId": "string",
"programName": "string",
"status": "string",
"groupId": "string",
"createdAt": "2024-01-01T00:00:00Z"
}
],
"has_more": true,
"next_cursor": "string"
}Schema
objectstringrequireddataobject[]requiredShow child parameters
idstringrequiredprogramIdstringrequiredprogramNamestringrequiredstatusstringrequiredgroupIdstringrequiredcreatedAtstringrequiredhas_morebooleanrequiredWhether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/graph GET /v1/programs/{id}/graph
Parameters
idstringpathrequiredrootstringqueryrequireddepthintegerqueryCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/graph?root=&depth="TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/graph?root=&depth=', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/graph?root=&depth=",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/graph?root=&depth=", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/graph?root=&depth=');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/graph?root=&depth=')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/graph?root=&depth="))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 The root partner node with its referral tree.
Example
{
"partnerId": "string",
"displayName": "string",
"email": "string",
"externalRef": "string",
"status": "string",
"commission": [
{
"currency": "string",
"amountMinor": 0
}
],
"referrals": [
{
"referralId": "string",
"customerRef": "string",
"status": "string",
"matchedVia": "string",
"ts": "2024-01-01T00:00:00Z",
"revenue": [
null
],
"commission": [
null
],
"partner": null
}
],
"depth": 0,
"truncated": true
}Schema
partnerIdstringrequireddisplayNamestringrequiredemailstringrequiredexternalRefstringrequiredstatusstringrequiredcommissionobject[]requiredShow child parameters
currencystringrequiredamountMinorintegerrequiredInteger minor units (cents).
referralsGraphReferral[]requiredShow child parameters
referralIdstringrequiredcustomerRefstringrequiredstatusstringrequiredmatchedViastringrequiredtsstringrequiredrevenueobject[]requiredShow child parameters
currencystringrequiredamountMinorintegerrequiredInteger minor units (cents).
commissionobject[]requiredShow child parameters
currencystringrequiredamountMinorintegerrequiredInteger minor units (cents).
partnerGraphPartnerrequiredShow child parameters
partnerIdstringrequireddisplayNamestringrequiredemailstringrequiredexternalRefstringrequiredstatusstringrequiredcommissionobject[]requiredreferralsGraphReferral[]requireddepthintegerrequiredtruncatedbooleanrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/partners/{id}/payout-profile GET /v1/partners/{id}/payout-profile
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"partnerId": "string",
"method": "string",
"payoutCurrency": "string",
"minThresholdMinor": 0,
"taxFormType": "string",
"taxFormSubmittedAt": "2024-01-01T00:00:00Z"
}Schema
partnerIdstringrequiredmethodstringrequiredpayoutCurrencystringrequiredminThresholdMinorintegerrequiredInteger minor units (cents).
taxFormTypestringrequiredtaxFormSubmittedAtstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
PUT
https://referally.15.204.158.166.sslip.io /v1/partners/{id}/payout-profile PUT /v1/partners/{id}/payout-profile
Parameters
idstringpathrequiredRequest body application/json
methodstringrequireddetailsobjectpayoutCurrencystringminThresholdMinorinteger{
"method": "paypal",
"details": {},
"payoutCurrency": "string",
"minThresholdMinor": 0
}Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile" \
-H "Content-Type: application/json" \
-d '{"method":"paypal","details":{},"payoutCurrency":"string","minThresholdMinor":0}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"method":"paypal","details":{},"payoutCurrency":"string","minThresholdMinor":0}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PUT",
"https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile",
headers={
"Content-Type": "application/json",
},
json={"method": "paypal", "details": {}, "payoutCurrency": "string", "minThresholdMinor": 0},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile", strings.NewReader(`{"method":"paypal","details":{},"payoutCurrency":"string","minThresholdMinor":0}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"method":"paypal","details":{},"payoutCurrency":"string","minThresholdMinor":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"method":"paypal","details":{},"payoutCurrency":"string","minThresholdMinor":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile"))
.header("Content-Type", "application/json")
.method("PUT", BodyPublishers.ofString("{\"method\":\"paypal\",\"details\":{},\"payoutCurrency\":\"string\",\"minThresholdMinor\":0}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string"
}Schema
idstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
PATCH
https://referally.15.204.158.166.sslip.io /v1/partners/{id}/payout-profile PATCH /v1/partners/{id}/payout-profile
Parameters
idstringpathrequiredRequest body application/json
minThresholdMinorintegerrequired{
"minThresholdMinor": 0
}Code samples
cURL
curl -X PATCH "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile" \
-H "Content-Type: application/json" \
-d '{"minThresholdMinor":0}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile', {
method: 'PATCH',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"minThresholdMinor":0}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PATCH",
"https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile",
headers={
"Content-Type": "application/json",
},
json={"minThresholdMinor": 0},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PATCH", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile", strings.NewReader(`{"minThresholdMinor":0}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"minThresholdMinor":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile')
req = Net::HTTP::Patch.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"minThresholdMinor":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}/payout-profile"))
.header("Content-Type", "application/json")
.method("PATCH", BodyPublishers.ofString("{\"minThresholdMinor\":0}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"partnerId": "string",
"method": "string",
"payoutCurrency": "string",
"minThresholdMinor": 0
}Schema
partnerIdstringrequiredmethodstringrequiredpayoutCurrencystringrequiredminThresholdMinorintegerrequiredInteger minor units (cents).
default Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/partners/{id}/tax-form POST /v1/partners/{id}/tax-form
Parameters
idstringpathrequiredRequest body application/json
typestringrequireddatarequired{
"type": "w9",
"data": {}
}Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/tax-form" \
-H "Content-Type: application/json" \
-d '{"type":"w9","data":{}}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/tax-form', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"type":"w9","data":{}}),
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/partners/{id}/tax-form",
headers={
"Content-Type": "application/json",
},
json={"type": "w9", "data": {}},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/tax-form", strings.NewReader(`{"type":"w9","data":{}}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}/tax-form');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"type":"w9","data":{}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/tax-form')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"type":"w9","data":{}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}/tax-form"))
.header("Content-Type", "application/json")
.method("POST", BodyPublishers.ofString("{\"type\":\"w9\",\"data\":{}}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"ok": true
}Schema
okbooleanrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/partners/{id}/quality GET /v1/partners/{id}/quality
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/quality"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/quality', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/partners/{id}/quality",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/partners/{id}/quality", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/partners/{id}/quality');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/partners/{id}/quality')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/partners/{id}/quality"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"partnerId": "string",
"live": {
"score": 0,
"metrics": {
"customers": 0,
"repeatPayerRate": 0,
"refundRate": 0,
"disputeRate": 0,
"trialToPaidRate": 0,
"identityRiskRate": 0
}
},
"lastSnapshot": {
"score": 0,
"metrics": {},
"computedAt": "2024-01-01T00:00:00Z"
}
}Schema
partnerIdstringrequiredliveobjectrequiredShow child parameters
scorenumberrequiredmetricsobjectrequiredShow child parameters
customersnumberrequiredrepeatPayerRatenumberrequiredrefundRatenumberrequireddisputeRatenumberrequiredtrialToPaidRatenumberrequiredidentityRiskRatenumberlastSnapshotobjectrequiredShow child parameters
scorenumberrequiredmetricsobjectrequiredcomputedAtstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/referee-reward GET /v1/programs/{id}/referee-reward
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"refereeReward": {}
}Schema
refereeRewardGetOpenapiJsonResponserequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
PUT
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/referee-reward PUT /v1/programs/{id}/referee-reward
Parameters
idstringpathrequiredRequest body application/json
enabledbooleankindstringamountMinorintegerbpsintegercapMinorintegeronstringroundingstringcurrencystring{
"enabled": true,
"kind": "store_credit",
"amountMinor": 0,
"bps": 0,
"capMinor": 0,
"on": "first_commission",
"rounding": "half_even",
"currency": "usd"
}Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward" \
-H "Content-Type: application/json" \
-d '{"enabled":true,"kind":"store_credit","amountMinor":0,"bps":0,"capMinor":0,"on":"first_commission","rounding":"half_even","currency":"usd"}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"enabled":true,"kind":"store_credit","amountMinor":0,"bps":0,"capMinor":0,"on":"first_commission","rounding":"half_even","currency":"usd"}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PUT",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward",
headers={
"Content-Type": "application/json",
},
json={"enabled": True, "kind": "store_credit", "amountMinor": 0, "bps": 0, "capMinor": 0, "on": "first_commission", "rounding": "half_even", "currency": "usd"},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward", strings.NewReader(`{"enabled":true,"kind":"store_credit","amountMinor":0,"bps":0,"capMinor":0,"on":"first_commission","rounding":"half_even","currency":"usd"}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"enabled":true,"kind":"store_credit","amountMinor":0,"bps":0,"capMinor":0,"on":"first_commission","rounding":"half_even","currency":"usd"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"enabled":true,"kind":"store_credit","amountMinor":0,"bps":0,"capMinor":0,"on":"first_commission","rounding":"half_even","currency":"usd"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/referee-reward"))
.header("Content-Type", "application/json")
.method("PUT", BodyPublishers.ofString("{\"enabled\":true,\"kind\":\"store_credit\",\"amountMinor\":0,\"bps\":0,\"capMinor\":0,\"on\":\"first_commission\",\"rounding\":\"half_even\",\"currency\":\"usd\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"ok": true,
"refereeReward": {}
}Schema
okbooleanrequiredrefereeRewardGetOpenapiJsonResponserequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/groups GET /v1/programs/{id}/groups
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
"object": "string",
"data": [
{
"id": "string",
"programId": "string",
"name": "string",
"base": null,
"holdDays": 0,
"minThresholdMinor": 0,
"payoutCurrency": "string",
"onboardingMessage": "string",
"onboardingChecklist": [
"string"
],
"members": 0,
"archivedAt": "2024-01-01T00:00:00Z",
"createdAt": "2024-01-01T00:00:00Z"
}
],
"has_more": true,
"next_cursor": "string"
}Schema
objectstringrequireddataPartnerGroup[]requiredShow child parameters
idstringrequiredprogramIdstringrequirednamestringrequiredbaseobjectrequiredholdDaysintegerrequiredminThresholdMinorintegerrequiredpayoutCurrencystringrequiredonboardingMessagestringrequiredonboardingCheckliststring[]requiredmembersintegerarchivedAtstringrequiredcreatedAtstringrequiredhas_morebooleanrequiredWhether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/groups POST /v1/programs/{id}/groups
Parameters
idstringpathrequiredRequest body application/json
namestringrequiredbaseobjectholdDaysintegerminThresholdMinorintegerpayoutCurrencystringonboardingMessagestringonboardingCheckliststring[]{
"name": "string",
"base": {
"kind": "string",
"bps": 0
},
"holdDays": 0,
"minThresholdMinor": 0,
"payoutCurrency": "string",
"onboardingMessage": "string",
"onboardingChecklist": [
"string"
]
}Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups" \
-H "Content-Type: application/json" \
-d '{"name":"string","base":{"kind":"string","bps":0},"holdDays":0,"minThresholdMinor":0,"payoutCurrency":"string","onboardingMessage":"string","onboardingChecklist":["string"]}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"name":"string","base":{"kind":"string","bps":0},"holdDays":0,"minThresholdMinor":0,"payoutCurrency":"string","onboardingMessage":"string","onboardingChecklist":["string"]}),
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups",
headers={
"Content-Type": "application/json",
},
json={"name": "string", "base": {"kind": "string", "bps": 0}, "holdDays": 0, "minThresholdMinor": 0, "payoutCurrency": "string", "onboardingMessage": "string", "onboardingChecklist": ["string"]},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups", strings.NewReader(`{"name":"string","base":{"kind":"string","bps":0},"holdDays":0,"minThresholdMinor":0,"payoutCurrency":"string","onboardingMessage":"string","onboardingChecklist":["string"]}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","base":{"kind":"string","bps":0},"holdDays":0,"minThresholdMinor":0,"payoutCurrency":"string","onboardingMessage":"string","onboardingChecklist":["string"]}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","base":{"kind":"string","bps":0},"holdDays":0,"minThresholdMinor":0,"payoutCurrency":"string","onboardingMessage":"string","onboardingChecklist":["string"]}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/groups"))
.header("Content-Type", "application/json")
.method("POST", BodyPublishers.ofString("{\"name\":\"string\",\"base\":{\"kind\":\"string\",\"bps\":0},\"holdDays\":0,\"minThresholdMinor\":0,\"payoutCurrency\":\"string\",\"onboardingMessage\":\"string\",\"onboardingChecklist\":[\"string\"]}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"programId": "string",
"name": "string",
"base": {
"kind": "string",
"bps": 0
},
"holdDays": 0,
"minThresholdMinor": 0,
"payoutCurrency": "string",
"onboardingMessage": "string",
"onboardingChecklist": [
"string"
],
"members": 0,
"archivedAt": "2024-01-01T00:00:00Z",
"createdAt": "2024-01-01T00:00:00Z"
}Schema
idstringrequiredprogramIdstringrequirednamestringrequiredbaseobjectrequiredholdDaysintegerrequiredminThresholdMinorintegerrequiredpayoutCurrencystringrequiredonboardingMessagestringrequiredonboardingCheckliststring[]requiredmembersintegerarchivedAtstringrequiredcreatedAtstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
PUT
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/partners/{partnerId}/group PUT /v1/programs/{id}/partners/{partnerId}/group
Parameters
idstringpathrequiredpartnerIdstringpathrequiredRequest body application/json
groupIdstringrequired{
"groupId": "string"
}Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/partners/{partnerId}/group" \
-H "Content-Type: application/json" \
-d '{"groupId":"string"}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/partners/{partnerId}/group', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"groupId":"string"}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PUT",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/partners/{partnerId}/group",
headers={
"Content-Type": "application/json",
},
json={"groupId": "string"},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/partners/{partnerId}/group", strings.NewReader(`{"groupId":"string"}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/partners/{partnerId}/group');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"groupId":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/partners/{partnerId}/group')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"groupId":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/partners/{partnerId}/group"))
.header("Content-Type", "application/json")
.method("PUT", BodyPublishers.ofString("{\"groupId\":\"string\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"partnerId": "string",
"programId": "string",
"groupId": "string"
}Schema
partnerIdstringrequiredprogramIdstringrequiredgroupIdstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/promotions GET /v1/programs/{id}/promotions
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
"object": "string",
"data": [
{
"id": "string",
"programId": "string",
"name": "string",
"groupId": "string",
"effect": {
"kind": null,
"base": null
},
"startsAt": "2024-01-01T00:00:00Z",
"endsAt": "2024-01-01T00:00:00Z",
"endedAt": "2024-01-01T00:00:00Z",
"status": "scheduled",
"createdAt": "2024-01-01T00:00:00Z"
}
],
"has_more": true,
"next_cursor": "string"
}Schema
objectstringrequireddataPromotion[]requiredShow child parameters
idstringrequiredprogramIdstringrequirednamestringrequiredgroupIdstringrequiredeffectobjectrequiredstartsAtstringrequiredendsAtstringrequiredendedAtstringrequiredstatusstringrequiredcreatedAtstringrequiredhas_morebooleanrequiredWhether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/promotions POST /v1/programs/{id}/promotions
Parameters
idstringpathrequiredRequest body application/json
namestringrequiredgroupIdstringeffectobjectrequiredstartsAtstringrequiredendsAtstringrequired{
"name": "string",
"groupId": "string",
"effect": {
"kind": "string",
"base": {
"kind": null,
"bps": null
}
},
"startsAt": "2024-01-01T00:00:00Z",
"endsAt": "2024-01-01T00:00:00Z"
}Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions" \
-H "Content-Type: application/json" \
-d '{"name":"string","groupId":"string","effect":{"kind":"string","base":{"kind":null,"bps":null}},"startsAt":"2024-01-01T00:00:00Z","endsAt":"2024-01-01T00:00:00Z"}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"name":"string","groupId":"string","effect":{"kind":"string","base":{"kind":null,"bps":null}},"startsAt":"2024-01-01T00:00:00Z","endsAt":"2024-01-01T00:00:00Z"}),
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions",
headers={
"Content-Type": "application/json",
},
json={"name": "string", "groupId": "string", "effect": {"kind": "string", "base": {"kind": None, "bps": None}}, "startsAt": "2024-01-01T00:00:00Z", "endsAt": "2024-01-01T00:00:00Z"},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions", strings.NewReader(`{"name":"string","groupId":"string","effect":{"kind":"string","base":{"kind":null,"bps":null}},"startsAt":"2024-01-01T00:00:00Z","endsAt":"2024-01-01T00:00:00Z"}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","groupId":"string","effect":{"kind":"string","base":{"kind":null,"bps":null}},"startsAt":"2024-01-01T00:00:00Z","endsAt":"2024-01-01T00:00:00Z"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","groupId":"string","effect":{"kind":"string","base":{"kind":null,"bps":null}},"startsAt":"2024-01-01T00:00:00Z","endsAt":"2024-01-01T00:00:00Z"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/promotions"))
.header("Content-Type", "application/json")
.method("POST", BodyPublishers.ofString("{\"name\":\"string\",\"groupId\":\"string\",\"effect\":{\"kind\":\"string\",\"base\":{\"kind\":null,\"bps\":null}},\"startsAt\":\"2024-01-01T00:00:00Z\",\"endsAt\":\"2024-01-01T00:00:00Z\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"id": "string",
"programId": "string",
"name": "string",
"groupId": "string",
"effect": {
"kind": "string",
"base": {
"kind": null,
"bps": null
}
},
"startsAt": "2024-01-01T00:00:00Z",
"endsAt": "2024-01-01T00:00:00Z",
"endedAt": "2024-01-01T00:00:00Z",
"status": "scheduled",
"createdAt": "2024-01-01T00:00:00Z"
}Schema
idstringrequiredprogramIdstringrequirednamestringrequiredgroupIdstringrequiredeffectobjectrequiredstartsAtstringrequiredendsAtstringrequiredendedAtstringrequiredstatusstringrequiredcreatedAtstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
PUT
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/incrementality PUT /v1/programs/{id}/incrementality
Parameters
idstringpathrequiredRequest body application/json
holdoutBpsintegerrequired{
"holdoutBps": 0
}Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/incrementality" \
-H "Content-Type: application/json" \
-d '{"holdoutBps":0}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/incrementality', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"holdoutBps":0}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PUT",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/incrementality",
headers={
"Content-Type": "application/json",
},
json={"holdoutBps": 0},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/incrementality", strings.NewReader(`{"holdoutBps":0}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/incrementality');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"holdoutBps":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/incrementality')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"holdoutBps":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/incrementality"))
.header("Content-Type", "application/json")
.method("PUT", BodyPublishers.ofString("{\"holdoutBps\":0}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"ok": true,
"holdoutBps": 0
}Schema
okbooleanrequiredholdoutBpsintegerrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
PUT
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/autopricing PUT /v1/programs/{id}/autopricing
Parameters
idstringpathrequiredRequest body application/json
enabledbooleantargetRoasnumberminBpsintegermaxBpsinteger{
"enabled": true,
"targetRoas": 5,
"minBps": 500,
"maxBps": 4000
}Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autopricing" \
-H "Content-Type: application/json" \
-d '{"enabled":true,"targetRoas":5,"minBps":500,"maxBps":4000}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autopricing', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"enabled":true,"targetRoas":5,"minBps":500,"maxBps":4000}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PUT",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autopricing",
headers={
"Content-Type": "application/json",
},
json={"enabled": True, "targetRoas": 5, "minBps": 500, "maxBps": 4000},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autopricing", strings.NewReader(`{"enabled":true,"targetRoas":5,"minBps":500,"maxBps":4000}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autopricing');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"enabled":true,"targetRoas":5,"minBps":500,"maxBps":4000}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autopricing')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"enabled":true,"targetRoas":5,"minBps":500,"maxBps":4000}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autopricing"))
.header("Content-Type", "application/json")
.method("PUT", BodyPublishers.ofString("{\"enabled\":true,\"targetRoas\":5,\"minBps\":500,\"maxBps\":4000}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"ok": true,
"autopricing": {}
}Schema
okbooleanrequiredautopricingGetOpenapiJsonResponserequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/autoprice/run POST /v1/programs/{id}/autoprice/run
Parameters
idstringpathrequiredCode samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autoprice/run"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autoprice/run', {
method: 'POST',
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autoprice/run",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autoprice/run", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autoprice/run');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autoprice/run')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/autoprice/run"))
.method("POST", BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"targetRoas": 0,
"changes": [
{
"partnerId": "string",
"fromBps": 0,
"toBps": 0,
"realizedRoas": 0
}
]
}Schema
targetRoasnumberrequiredchangesobject[]requiredShow child parameters
partnerIdstringrequiredfromBpsintegerrequiredtoBpsintegerrequiredrealizedRoasnumberrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/negotiation-policy GET /v1/programs/{id}/negotiation-policy
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"negotiationPolicy": {}
}Schema
negotiationPolicyGetOpenapiJsonResponserequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
PUT
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/negotiation-policy PUT /v1/programs/{id}/negotiation-policy
Parameters
idstringpathrequiredRequest body application/json
enabledbooleanminBpsintegerrequiredmaxBpsintegerrequiredautoAcceptMaxBpsintegerrequired{
"enabled": true,
"minBps": 0,
"maxBps": 0,
"autoAcceptMaxBps": 0
}Code samples
cURL
curl -X PUT "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy" \
-H "Content-Type: application/json" \
-d '{"enabled":true,"minBps":0,"maxBps":0,"autoAcceptMaxBps":0}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy', {
method: 'PUT',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"enabled":true,"minBps":0,"maxBps":0,"autoAcceptMaxBps":0}),
});
const data = await res.json();Python
import requests
res = requests.request(
"PUT",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy",
headers={
"Content-Type": "application/json",
},
json={"enabled": True, "minBps": 0, "maxBps": 0, "autoAcceptMaxBps": 0},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("PUT", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy", strings.NewReader(`{"enabled":true,"minBps":0,"maxBps":0,"autoAcceptMaxBps":0}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"enabled":true,"minBps":0,"maxBps":0,"autoAcceptMaxBps":0}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy')
req = Net::HTTP::Put.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"enabled":true,"minBps":0,"maxBps":0,"autoAcceptMaxBps":0}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/negotiation-policy"))
.header("Content-Type", "application/json")
.method("PUT", BodyPublishers.ofString("{\"enabled\":true,\"minBps\":0,\"maxBps\":0,\"autoAcceptMaxBps\":0}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"ok": true,
"negotiationPolicy": {}
}Schema
okbooleanrequirednegotiationPolicyGetOpenapiJsonResponserequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/apply-leveling Promote partners through configured levels
Parameters
idstringpathrequiredCode samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/apply-leveling"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/apply-leveling', {
method: 'POST',
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/apply-leveling",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/apply-leveling", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/apply-leveling');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/apply-leveling')
req = Net::HTTP::Post.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/apply-leveling"))
.method("POST", BodyPublishers.noBody())
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"evaluated": 0,
"promoted": 0
}Schema
evaluatedintegerrequiredpromotedintegerrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/programs/{id}/terms-acceptances GET /v1/programs/{id}/terms-acceptances
Parameters
idstringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/terms-acceptances"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/terms-acceptances', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/programs/{id}/terms-acceptances",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/programs/{id}/terms-acceptances", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/programs/{id}/terms-acceptances');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/programs/{id}/terms-acceptances')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/programs/{id}/terms-acceptances"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 A page of the list. Under referally-version 2026-10-21 the body is the plain array instead.
Example
{
"object": "string",
"data": [
{
"version": 0,
"partnerEmail": "string",
"acceptedAt": "2024-01-01T00:00:00Z"
}
],
"has_more": true,
"next_cursor": "string"
}Schema
objectstringrequireddataobject[]requiredShow child parameters
versionintegerrequiredpartnerEmailstringrequiredacceptedAtstringrequiredhas_morebooleanrequiredWhether another page follows; pass next_cursor as starting_after to get it.
next_cursorstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
GET
https://referally.15.204.158.166.sslip.io /v1/public/programs/{handle} Public affiliate program landing data (no auth)
Parameters
handlestringpathrequiredCode samples
cURL
curl -X GET "https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}"TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}', {
method: 'GET',
});
const data = await res.json();Python
import requests
res = requests.request(
"GET",
"https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}",
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
req, _ := http.NewRequest("GET", "https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}", nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}')
req = Net::HTTP::Get.new(uri)
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}"))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"handle": "string",
"programId": "string",
"programName": "string",
"merchant": "string",
"trackingToken": "string",
"cookieWindowDays": 0,
"termsMd": "string",
"pitch": "string",
"autoApprove": true,
"commission": {},
"branding": {
"logoUrl": "string",
"theme": {}
}
}Schema
handlestringrequiredprogramIdstringrequiredprogramNamestringrequiredmerchantstringrequiredtrackingTokenstringrequiredcookieWindowDaysintegerrequiredtermsMdstringrequiredpitchstringrequiredautoApprovebooleanrequiredcommissionGetOpenapiJsonResponserequiredbrandingobjectrequiredShow child parameters
logoUrlstringrequiredthemeGetOpenapiJsonResponserequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
POST
https://referally.15.204.158.166.sslip.io /v1/public/programs/{handle}/join One-step affiliate signup + enrollment
Parameters
handlestringpathrequiredRequest body application/json
destinationUrlstring{
"destinationUrl": "string"
}Code samples
cURL
curl -X POST "https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}/join" \
-H "Content-Type: application/json" \
-d '{"destinationUrl":"string"}'TypeScript
const res = await fetch('https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}/join', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
},
body: JSON.stringify({"destinationUrl":"string"}),
});
const data = await res.json();Python
import requests
res = requests.request(
"POST",
"https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}/join",
headers={
"Content-Type": "application/json",
},
json={"destinationUrl": "string"},
)
data = res.json()Go
package main
import (
"fmt"
"io"
"net/http"
"strings"
)
func main() {
req, _ := http.NewRequest("POST", "https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}/join", strings.NewReader(`{"destinationUrl":"string"}`))
req.Header.Set("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}PHP
<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}/join');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"destinationUrl":"string"}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;Ruby
require 'net/http'
require 'uri'
uri = URI('https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}/join')
req = Net::HTTP::Post.new(uri)
req['Content-Type'] = 'application/json'
req.body = '{"destinationUrl":"string"}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
http.request(req)
end
puts res.bodyJava
import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://referally.15.204.158.166.sslip.io/v1/public/programs/{handle}/join"))
.header("Content-Type", "application/json")
.method("POST", BodyPublishers.ofString("{\"destinationUrl\":\"string\"}"))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());Responses
200 OK
Example
{
"accountId": "string",
"status": "approved",
"link": "string",
"linkUrl": "string",
"code": "string",
"portalUrl": "string"
}Schema
accountIdstringrequiredstatusstringrequiredlinkstringrequiredlinkUrlstringrequiredcodestringrequiredportalUrlstringrequireddefault Error
Example
{
"error": {
"code": "string",
"message": "string",
"details": {},
"requestId": "string",
"docs_url": "string"
}
}Schema
errorobjectrequiredShow child parameters
codestringrequiredmessagestringrequireddetailsrequestIdstringdocs_urlstringrequiredThe docs entry for this error code: what it means and how to fix it.
Updated