Create lead by offer ID (POST)

curl --request POST \
  --url https://{domain}/api/v2/affiliate/leads-by-offer-id \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "offer_id": 1,
  "affiliate_id": 1,
  "goal_id": 1,
  "revenue": 1,
  "payout": 1,
  "amount": 1
}
'

import requests

url = "https://{domain}/api/v2/affiliate/leads-by-offer-id"

payload = {
    "offer_id": 1,
    "affiliate_id": 1,
    "goal_id": 1,
    "revenue": 1,
    "payout": 1,
    "amount": 1
}
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({offer_id: 1, affiliate_id: 1, goal_id: 1, revenue: 1, payout: 1, amount: 1})
};

fetch('https://{domain}/api/v2/affiliate/leads-by-offer-id', 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-by-offer-id",
  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([
    'offer_id' => 1,
    'affiliate_id' => 1,
    'goal_id' => 1,
    'revenue' => 1,
    'payout' => 1,
    'amount' => 1
  ]),
  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-by-offer-id"

	payload := strings.NewReader("{\n  \"offer_id\": 1,\n  \"affiliate_id\": 1,\n  \"goal_id\": 1,\n  \"revenue\": 1,\n  \"payout\": 1,\n  \"amount\": 1\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-by-offer-id")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"offer_id\": 1,\n  \"affiliate_id\": 1,\n  \"goal_id\": 1,\n  \"revenue\": 1,\n  \"payout\": 1,\n  \"amount\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/affiliate/leads-by-offer-id")

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  \"offer_id\": 1,\n  \"affiliate_id\": 1,\n  \"goal_id\": 1,\n  \"revenue\": 1,\n  \"payout\": 1,\n  \"amount\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "<string>",
  "info": {
    "result": {}
  }
}

{
  "message": "Request could not be parsed.",
  "success": false,
  "info": {
    "errors": {}
  }
}

{
  "message": "API key is invalid or missing.",
  "success": false
}

{
  "message": "This endpoint is not available for your role.",
  "success": false
}

{
  "message": "Validation error",
  "success": false,
  "info": {
    "errors": {
      "email": [
        "Email cannot be blank."
      ],
      "currency": [
        "Currency must be a valid ISO code."
      ]
    }
  }
}

{
  "message": "An unexpected error occurred.",
  "success": false,
  "info": {
    "errors": {}
  }
}

POST

api

affiliate

leads-by-offer-id

Create lead by offer ID (POST)

curl --request POST \
  --url https://{domain}/api/v2/affiliate/leads-by-offer-id \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "offer_id": 1,
  "affiliate_id": 1,
  "goal_id": 1,
  "revenue": 1,
  "payout": 1,
  "amount": 1
}
'

import requests

url = "https://{domain}/api/v2/affiliate/leads-by-offer-id"

payload = {
    "offer_id": 1,
    "affiliate_id": 1,
    "goal_id": 1,
    "revenue": 1,
    "payout": 1,
    "amount": 1
}
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({offer_id: 1, affiliate_id: 1, goal_id: 1, revenue: 1, payout: 1, amount: 1})
};

fetch('https://{domain}/api/v2/affiliate/leads-by-offer-id', 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-by-offer-id",
  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([
    'offer_id' => 1,
    'affiliate_id' => 1,
    'goal_id' => 1,
    'revenue' => 1,
    'payout' => 1,
    'amount' => 1
  ]),
  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-by-offer-id"

	payload := strings.NewReader("{\n  \"offer_id\": 1,\n  \"affiliate_id\": 1,\n  \"goal_id\": 1,\n  \"revenue\": 1,\n  \"payout\": 1,\n  \"amount\": 1\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-by-offer-id")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"offer_id\": 1,\n  \"affiliate_id\": 1,\n  \"goal_id\": 1,\n  \"revenue\": 1,\n  \"payout\": 1,\n  \"amount\": 1\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{domain}/api/v2/affiliate/leads-by-offer-id")

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  \"offer_id\": 1,\n  \"affiliate_id\": 1,\n  \"goal_id\": 1,\n  \"revenue\": 1,\n  \"payout\": 1,\n  \"amount\": 1\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "code": 200,
  "name": "OK",
  "message": "<string>",
  "info": {
    "result": {}
  }
}

{
  "message": "Request could not be parsed.",
  "success": false,
  "info": {
    "errors": {}
  }
}

{
  "message": "API key is invalid or missing.",
  "success": false
}

{
  "message": "This endpoint is not available for your role.",
  "success": false
}

{
  "message": "Validation error",
  "success": false,
  "info": {
    "errors": {
      "email": [
        "Email cannot be blank."
      ],
      "currency": [
        "Currency must be a valid ISO code."
      ]
    }
  }
}

{
  "message": "An unexpected error occurred.",
  "success": false,
  "info": {
    "errors": {}
  }
}

Authorizations

X-API-Key

string

header

required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Body

application/json

offer_id

integer

required

affiliate_id

integer

goal_id

integer

deliver_lead

enum<string>

default:no

Forwards the created lead to the external systems configured for its goal. With yes the lead is posted out; with no (the default) it is only recorded in Scaleo. Delivery needs the Leads Management Module, an active Receive campaign bound to the lead's goal_id, and at least one active Deliver vendor on that campaign - without them, or when a vendor's posting instructions are empty, yes has no effect. Each vendor is called with its own posting instructions (URL, method, headers, tokenized body); its answer is matched against the vendor's success reply and sets the lead's delivery status - success, fail, or empty when the vendor has no success reply configured. Every attempt is stored in the leads log as an Outgoing Lead record. Leads that end up in the trash conversion status (failed campaign validation, geo check, or cap) are never delivered. If the vendor has "return reply" enabled, its raw response is added to the response payload as delivery_reply. Requests authenticated with an affiliate-role API key are an exception: the value is overwritten with yes before the lead is processed, so an affiliate integration cannot switch delivery off on this endpoint. Only manager-level API keys can send no here.

Available options:

yes,

no

revenue

number

payout

number

amount

number

conv_status

enum<string>

Available options:

pending,

approved,

rejected,

hold

string

firstname

string

lastname

string

phone

string

gender

enum<string>

Available options:

m,

f

birthday

string<date>

address

string

city

string

region

string

postcode

string

country

string

vertical

string

idfa

string

gaid

string

deep_link

string

sub_id1

string

sub_id2

string

sub_id3

string

sub_id4

string

sub_id5

string

aff_param1

string

aff_param2

string

aff_param3

string

aff_param4

string

aff_param5

string

custom1

string

custom2

string

custom3

string

custom4

string

custom5

string

custom6

string

custom7

string

custom8

string

custom9

string

custom10

string

public_notes

string

private_notes

string

Response

Lead creation result.

status

string

Example:

"success"

code

integer

Example:

200

name

string

Example:

"OK"

message

string

info

object

Show child attributes

Getting started

Manager

Affiliate

Advertiser

Reference

Create lead by offer ID (POST)

Authorizations

Body

Response