curl --request POST \
--url https://{domain}/api/v2/affiliate/leads \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"aff_click_id": "string",
"goal_id": 1,
"revenue": 1,
"payout": 1,
"amount": 1,
"conv_status": "pending"
}
'import requests
url = "https://{domain}/api/v2/affiliate/leads"
payload = {
"aff_click_id": "string",
"goal_id": 1,
"revenue": 1,
"payout": 1,
"amount": 1,
"conv_status": "pending"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
aff_click_id: 'string',
goal_id: 1,
revenue: 1,
payout: 1,
amount: 1,
conv_status: 'pending'
})
};
fetch('https://{domain}/api/v2/affiliate/leads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/affiliate/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'aff_click_id' => 'string',
'goal_id' => 1,
'revenue' => 1,
'payout' => 1,
'amount' => 1,
'conv_status' => 'pending'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/v2/affiliate/leads"
payload := strings.NewReader("{\n \"aff_click_id\": \"string\",\n \"goal_id\": 1,\n \"revenue\": 1,\n \"payout\": 1,\n \"amount\": 1,\n \"conv_status\": \"pending\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{domain}/api/v2/affiliate/leads")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"aff_click_id\": \"string\",\n \"goal_id\": 1,\n \"revenue\": 1,\n \"payout\": 1,\n \"amount\": 1,\n \"conv_status\": \"pending\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/affiliate/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"aff_click_id\": \"string\",\n \"goal_id\": 1,\n \"revenue\": 1,\n \"payout\": 1,\n \"amount\": 1,\n \"conv_status\": \"pending\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>",
"info": {
"result": {}
}
}{
"status": "error",
"code": 400,
"name": "Bad Request",
"message": "Request could not be parsed.",
"info": {
"errors": {}
}
}{
"status": "error",
"code": 401,
"name": "Unauthorized",
"message": "API key is invalid or missing."
}{
"status": "error",
"code": 403,
"name": "Forbidden",
"message": "This endpoint is not available for your role."
}{
"status": "error",
"code": 422,
"name": "Unprocessable entity",
"message": "Validation error",
"info": {
"errors": {
"email": [
"Email cannot be blank."
],
"currency": [
"Currency must be a valid ISO code."
]
}
}
}{
"status": "error",
"code": 500,
"name": "Internal Server Error",
"message": "An unexpected error occurred.",
"info": {
"errors": {}
}
}Create lead by click ID (POST)
Creates a lead using an existing affiliate click ID via POST. Lead delivery is unconditional on this endpoint: when the lead’s goal has an active Receive campaign with active Deliver vendors, the lead is always posted out to them - the only exception is a lead that ends up in the trash conversion status. The deliver_lead switch is accepted by the request but not evaluated here; use /api/v2/network/leads, /api/v2/network/leads-by-goal-id or /api/v2/network/leads-by-offer-id when delivery has to be opt-in per request.
curl --request POST \
--url https://{domain}/api/v2/affiliate/leads \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '
{
"aff_click_id": "string",
"goal_id": 1,
"revenue": 1,
"payout": 1,
"amount": 1,
"conv_status": "pending"
}
'import requests
url = "https://{domain}/api/v2/affiliate/leads"
payload = {
"aff_click_id": "string",
"goal_id": 1,
"revenue": 1,
"payout": 1,
"amount": 1,
"conv_status": "pending"
}
headers = {
"X-API-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
aff_click_id: 'string',
goal_id: 1,
revenue: 1,
payout: 1,
amount: 1,
conv_status: 'pending'
})
};
fetch('https://{domain}/api/v2/affiliate/leads', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{domain}/api/v2/affiliate/leads",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'aff_click_id' => 'string',
'goal_id' => 1,
'revenue' => 1,
'payout' => 1,
'amount' => 1,
'conv_status' => 'pending'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{domain}/api/v2/affiliate/leads"
payload := strings.NewReader("{\n \"aff_click_id\": \"string\",\n \"goal_id\": 1,\n \"revenue\": 1,\n \"payout\": 1,\n \"amount\": 1,\n \"conv_status\": \"pending\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{domain}/api/v2/affiliate/leads")
.header("X-API-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"aff_click_id\": \"string\",\n \"goal_id\": 1,\n \"revenue\": 1,\n \"payout\": 1,\n \"amount\": 1,\n \"conv_status\": \"pending\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{domain}/api/v2/affiliate/leads")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"aff_click_id\": \"string\",\n \"goal_id\": 1,\n \"revenue\": 1,\n \"payout\": 1,\n \"amount\": 1,\n \"conv_status\": \"pending\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"code": 200,
"name": "OK",
"message": "<string>",
"info": {
"result": {}
}
}{
"status": "error",
"code": 400,
"name": "Bad Request",
"message": "Request could not be parsed.",
"info": {
"errors": {}
}
}{
"status": "error",
"code": 401,
"name": "Unauthorized",
"message": "API key is invalid or missing."
}{
"status": "error",
"code": 403,
"name": "Forbidden",
"message": "This endpoint is not available for your role."
}{
"status": "error",
"code": 422,
"name": "Unprocessable entity",
"message": "Validation error",
"info": {
"errors": {
"email": [
"Email cannot be blank."
],
"currency": [
"Currency must be a valid ISO code."
]
}
}
}{
"status": "error",
"code": 500,
"name": "Internal Server Error",
"message": "An unexpected error occurred.",
"info": {
"errors": {}
}
}Authorizations
Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.
Body
Affiliate click ID.
pending, approved, rejected, hold m, f Visitor IP address.
iOS advertising identifier.
Google advertising identifier.
Was this page helpful?