curl --request PUT \
--url https://firstpromoter.com/api/v1/leads/update \
--header 'X-API-KEY: <api-key>'import requests
url = "https://firstpromoter.com/api/v1/leads/update"
headers = {"X-API-KEY": "<api-key>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://firstpromoter.com/api/v1/leads/update', 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://firstpromoter.com/api/v1/leads/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://firstpromoter.com/api/v1/leads/update"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://firstpromoter.com/api/v1/leads/update")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firstpromoter.com/api/v1/leads/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 123,
"state": "signup",
"uid": "<unknown>",
"email": "jsmith@example.com",
"customer_since": "<string>",
"cancelled_at": "<string>",
"plan_name": "<string>",
"suspicion": "<string>",
"username": "<string>",
"website": "<string>",
"created_at": "<string>",
"split_promotion_id": "<unknown>",
"custom_fields": "<unknown>",
"split_percentage_value": "<unknown>",
"visitor_sub_id": "<unknown>",
"promotion": {
"id": 123,
"status": "<string>",
"ref_id": "<string>",
"promo_code": "<string>",
"customer_promo_code": "<string>",
"target_reached_at": "<string>",
"promoter_id": 123,
"campaign_id": 123,
"referral_link": "<string>",
"current_offer": {
"id": 123,
"name": "<string>",
"amount": 123,
"unit": "<string>",
"default_promo_code": "<string>"
},
"current_referral_reward": {
"id": 123,
"amount": 123,
"unit": "<string>",
"name": "<string>",
"per_of_sale": 123,
"default_promo_code": "<string>"
},
"current_promotion_reward": {},
"current_target_reward": {},
"campaign_name": "<string>",
"hidden": true,
"visitors_count": 123,
"leads_count": 123,
"customers_count": 123,
"refunds_count": 123,
"cancellations_count": 123,
"sales_count": 123,
"sales_total": 123,
"refunds_total": 123,
"active_customers_count": 123
},
"promoter": {
"id": 123,
"status": "approved",
"cust_id": "<unknown>",
"email": "<string>",
"created_at": "<string>",
"temp_password": "<string>",
"default_promotion_id": 123,
"pref": "<string>",
"default_ref_id": "<string>",
"note": "<string>",
"w8_form_url": "<unknown>",
"w9_form_url": "<unknown>",
"parent_promoter_id": "<string>",
"earnings_balance": {},
"current_balance": {},
"paid_balance": {},
"auth_token": "<string>"
}
}"Bad credentials"{
"error": "Lead not found."
}{
"error": "<string>"
}Modify existing lead/customer
Update a lead or customer’s email, uid, state, ref_id or dates, found by id, uid or email (legacy v1 API).
curl --request PUT \
--url https://firstpromoter.com/api/v1/leads/update \
--header 'X-API-KEY: <api-key>'import requests
url = "https://firstpromoter.com/api/v1/leads/update"
headers = {"X-API-KEY": "<api-key>"}
response = requests.put(url, headers=headers)
print(response.text)const options = {method: 'PUT', headers: {'X-API-KEY': '<api-key>'}};
fetch('https://firstpromoter.com/api/v1/leads/update', 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://firstpromoter.com/api/v1/leads/update",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://firstpromoter.com/api/v1/leads/update"
req, _ := http.NewRequest("PUT", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://firstpromoter.com/api/v1/leads/update")
.header("X-API-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://firstpromoter.com/api/v1/leads/update")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-API-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": 123,
"state": "signup",
"uid": "<unknown>",
"email": "jsmith@example.com",
"customer_since": "<string>",
"cancelled_at": "<string>",
"plan_name": "<string>",
"suspicion": "<string>",
"username": "<string>",
"website": "<string>",
"created_at": "<string>",
"split_promotion_id": "<unknown>",
"custom_fields": "<unknown>",
"split_percentage_value": "<unknown>",
"visitor_sub_id": "<unknown>",
"promotion": {
"id": 123,
"status": "<string>",
"ref_id": "<string>",
"promo_code": "<string>",
"customer_promo_code": "<string>",
"target_reached_at": "<string>",
"promoter_id": 123,
"campaign_id": 123,
"referral_link": "<string>",
"current_offer": {
"id": 123,
"name": "<string>",
"amount": 123,
"unit": "<string>",
"default_promo_code": "<string>"
},
"current_referral_reward": {
"id": 123,
"amount": 123,
"unit": "<string>",
"name": "<string>",
"per_of_sale": 123,
"default_promo_code": "<string>"
},
"current_promotion_reward": {},
"current_target_reward": {},
"campaign_name": "<string>",
"hidden": true,
"visitors_count": 123,
"leads_count": 123,
"customers_count": 123,
"refunds_count": 123,
"cancellations_count": 123,
"sales_count": 123,
"sales_total": 123,
"refunds_total": 123,
"active_customers_count": 123
},
"promoter": {
"id": 123,
"status": "approved",
"cust_id": "<unknown>",
"email": "<string>",
"created_at": "<string>",
"temp_password": "<string>",
"default_promotion_id": 123,
"pref": "<string>",
"default_ref_id": "<string>",
"note": "<string>",
"w8_form_url": "<unknown>",
"w9_form_url": "<unknown>",
"parent_promoter_id": "<string>",
"earnings_balance": {},
"current_balance": {},
"paid_balance": {},
"auth_token": "<string>"
}
}"Bad credentials"{
"error": "Lead not found."
}{
"error": "<string>"
}id, uid or emailQuery Parameters
ISO datetime when the referral was created. A lead that has not bought yet expires once its creation date is older than the company's lead expiry window, so changing this date also moves that window. It has no effect on a cancelled customer's expiry; use reset_expiry to clear either kind.
Set this to true to clear the referral's expired status. It restarts both expiry windows from now: the lead window (no sale since signup) and the cancelled-customer window (time since cancellation). The referral's state, creation date, customer_since and cancellation date don't change, and it can expire again once the company's expiry window has passed.
Only relevant when the company has referral expiry set.
Response
Success response