Update Lead API

POST

api

lead

update

{cid}

cURL

curl --request POST \
  --url https://api.pingtree.com/api/lead/update/{cid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "transaction_id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "mobile": "<string>",
  "address": "<string>",
  "state": "<string>",
  "city": "<string>",
  "zip_code": "<string>",
  "date_of_birth": "<string>"
}
'

import requests

url = "https://api.pingtree.com/api/lead/update/{cid}"

payload = {
    "transaction_id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "mobile": "<string>",
    "address": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zip_code": "<string>",
    "date_of_birth": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    transaction_id: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    email: '<string>',
    mobile: '<string>',
    address: '<string>',
    state: '<string>',
    city: '<string>',
    zip_code: '<string>',
    date_of_birth: '<string>'
  })
};

fetch('https://api.pingtree.com/api/lead/update/{cid}', 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://api.pingtree.com/api/lead/update/{cid}",
  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([
    'transaction_id' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'email' => '<string>',
    'mobile' => '<string>',
    'address' => '<string>',
    'state' => '<string>',
    'city' => '<string>',
    'zip_code' => '<string>',
    'date_of_birth' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pingtree.com/api/lead/update/{cid}"

	payload := strings.NewReader("{\n  \"transaction_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"address\": \"<string>\",\n  \"state\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip_code\": \"<string>\",\n  \"date_of_birth\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.pingtree.com/api/lead/update/{cid}")
  .header("Content-Type", "application/json")
  .body("{\n  \"transaction_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"address\": \"<string>\",\n  \"state\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip_code\": \"<string>\",\n  \"date_of_birth\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pingtree.com/api/lead/update/{cid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"transaction_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"address\": \"<string>\",\n  \"state\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip_code\": \"<string>\",\n  \"date_of_birth\": \"<string>\"\n}"

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

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

Overview

The Update Lead API enriches or corrects an existing lead record in a campaign. Use it when additional data becomes available after initial submission — for example, after a secondary form step, a phone verification flow, or a credit check callback. The lead is identified by transaction_id and the campaign’s offer campaign ID.

Endpoint

POST /api/lead/update/{offerCampaignId}

Replace {offerCampaignId} with the unique identifier of the offer campaign (available in your posting spec or dashboard).

Authentication

Include the enrichment token in the Authorization header:

Authorization: Bearer <your-enrichment-token>

The enrichment token is distinct from the standard form API token and is listed separately in your posting specification.

Request Parameters

Path Parameters

Parameter	Type	Required	Description
`offerCampaignId`	string	Yes	The unique ID of the offer campaign

Body Parameters (JSON)

Parameter	Type	Required	Description
`transaction_id`	string	Yes	The transaction ID returned by the original lead submission
`first_name`	string	No	Updated first name
`last_name`	string	No	Updated last name
`email`	string	No	Updated email address
`mobile`	string	No	Updated 10-digit mobile number
`address`	string	No	Updated street address
`city`	string	No	Updated city
`state`	string	No	Updated state abbreviation
`zip_code`	string	No	Updated ZIP code
`date_of_birth`	string	No	Updated date of birth (YYYY-MM-DD)
`sub1` – `sub5`	string	No	Updated publisher sub-parameters
`adv1` – `adv5`	string	No	Updated advertiser sub-parameters

Any campaign-specific custom fields (e.g. loan_amount, credit_score) can also be included in the body. Only fields present in the request body are updated; existing field values are not overwritten if omitted.

Example Request

curl -X POST "https://api.pingtree.com/api/lead/update/cmp_9z8y7x6w" \
  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..." \
  -H "Content-Type: application/json" \
  -d '{
    "transaction_id": "txn_7f3a2b1c-4d56-78ef-9012-abcdef123456",
    "loan_amount": 15000,
    "credit_score": "good",
    "home_owner": true
  }'

Example Responses

Success — Lead Updated

{
  "status": "201",
  "message": "Lead successfully updated",
  "transaction_id": "txn_7f3a2b1c-4d56-78ef-9012-abcdef123456",
  "data": {
    "transaction_id": "txn_7f3a2b1c-4d56-78ef-9012-abcdef123456",
    "leadStatus": "accepted",
    "redirect_url": "https://thank-you.example.com?tid=txn_7f3a2b1c"
  },
  "isDeDupe": false
}

Error — Missing Transaction ID

{
  "status": "400",
  "message": "transaction_id is required",
  "data": {
    "leadStatus": "missingField"
  }
}

Error — Lead Not Found

{
  "status": "400",
  "message": "Lead not found for the given transaction_id",
  "data": {
    "leadStatus": "rejected"
  }
}

Error — Unauthorized

{
  "status": "401",
  "message": "Unauthorized",
  "data": {
    "leadStatus": "rejected"
  }
}

Status Codes

HTTP Code	Lead Status	Description
201	`accepted`	Lead was updated and re-evaluated successfully
201	`unsold`	Lead was updated but not re-distributed
400	`missingField`	`transaction_id` or another required enrichment field is missing
400	`invalidField`	A field failed format validation
400	`rejected`	The lead record was not found or the update was rejected
401	`rejected`	Invalid or missing enrichment token
405	`rejected`	HTTP method not allowed
500	`rejected`	Internal server error

Tips

transaction_id is mandatory. The update endpoint uses it to locate the original lead record. Always store this value from the initial form submission response.
Partial updates are safe. Only send the fields you want to change. Fields not included in the request are left unchanged.
Re-distribution: Depending on campaign settings, updating a lead may trigger re-distribution to buyers. Check with your campaign manager if re-posting behaviour is required.
Enrichment token vs form token: These are different credentials. Using the wrong token returns a 401 error.

Path Parameters

cid

string

required

Your campaign unique ID

Body

application/json

Lead details to add to the campaign

transaction_id

string

required

Lead's Transaction ID, Which was generate from click script of Pingtree

first_name

string

First name of the lead

last_name

string

Last name of the lead

string

Email of the lead

mobile

string

Mobile of the lead

address

string

Address of the lead

state

string

State of the lead

city

string

City of the lead

zip_code

string

Zip Code of the lead

date_of_birth

string

Date of Birth of the lead

Response

Lead successfully updated

status

string

Status code of API response

type

string

Type of API response which can be success or error

message

string

Message of API response

Fetch Form Submission APIThe Update Form API is used to modify existing lead form data within a campaign. This API is especially useful when updating incorrect details, adding new information, or making adjustments to previously submitted leads to ensure accurate campaign records.

cURL

curl --request POST \
  --url https://api.pingtree.com/api/lead/update/{cid} \
  --header 'Content-Type: application/json' \
  --data '
{
  "transaction_id": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "email": "<string>",
  "mobile": "<string>",
  "address": "<string>",
  "state": "<string>",
  "city": "<string>",
  "zip_code": "<string>",
  "date_of_birth": "<string>"
}
'

import requests

url = "https://api.pingtree.com/api/lead/update/{cid}"

payload = {
    "transaction_id": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "email": "<string>",
    "mobile": "<string>",
    "address": "<string>",
    "state": "<string>",
    "city": "<string>",
    "zip_code": "<string>",
    "date_of_birth": "<string>"
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    transaction_id: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    email: '<string>',
    mobile: '<string>',
    address: '<string>',
    state: '<string>',
    city: '<string>',
    zip_code: '<string>',
    date_of_birth: '<string>'
  })
};

fetch('https://api.pingtree.com/api/lead/update/{cid}', 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://api.pingtree.com/api/lead/update/{cid}",
  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([
    'transaction_id' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'email' => '<string>',
    'mobile' => '<string>',
    'address' => '<string>',
    'state' => '<string>',
    'city' => '<string>',
    'zip_code' => '<string>',
    'date_of_birth' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pingtree.com/api/lead/update/{cid}"

	payload := strings.NewReader("{\n  \"transaction_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"address\": \"<string>\",\n  \"state\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip_code\": \"<string>\",\n  \"date_of_birth\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	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://api.pingtree.com/api/lead/update/{cid}")
  .header("Content-Type", "application/json")
  .body("{\n  \"transaction_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"address\": \"<string>\",\n  \"state\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip_code\": \"<string>\",\n  \"date_of_birth\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.pingtree.com/api/lead/update/{cid}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"transaction_id\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"email\": \"<string>\",\n  \"mobile\": \"<string>\",\n  \"address\": \"<string>\",\n  \"state\": \"<string>\",\n  \"city\": \"<string>\",\n  \"zip_code\": \"<string>\",\n  \"date_of_birth\": \"<string>\"\n}"

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

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>"
}

API Documentation

Offer Campaign APIs

Database Source

Global Event Postback API

Overview

Endpoint

Authentication

Request Parameters

Path Parameters

Body Parameters (JSON)

Example Request

Example Responses

Success — Lead Updated

Error — Missing Transaction ID

Error — Lead Not Found

Error — Unauthorized

Status Codes

Tips

Path Parameters

Body

Response

​Overview

​Endpoint

​Authentication

​Request Parameters

​Path Parameters

​Body Parameters (JSON)

​Example Request

​Example Responses

​Success — Lead Updated

​Error — Missing Transaction ID

​Error — Lead Not Found

​Error — Unauthorized

​Status Codes

​Tips

Path Parameters

Body

Response

Overview

Endpoint

Authentication

Request Parameters

Path Parameters

Body Parameters (JSON)

Example Request

Example Responses

Success — Lead Updated

Error — Missing Transaction ID

Error — Lead Not Found

Error — Unauthorized

Status Codes

Tips