Skip to main content
POST
cURL

Overview

The Create Form API submits a lead captured from a landing page or campaign form directly into the Pingtree lead distribution system. The lead is evaluated, distributed to buyers, and a response is returned indicating acceptance status, redirect URL, and deduplication state.

Endpoint

Replace {source-unique-id} with the unique link ID assigned to your campaign source (found in your posting spec).

Authentication

Include your API token in the Authorization header:
The token is source-specific and is provided in your campaign’s posting specification.

Request Parameters

Path Parameters

Body Parameters (JSON or form-encoded)

Required fields depend on the campaign configuration. Check your posting spec for the exact list of required fields.

Example Request

Example Responses

Success — Lead Accepted

Success — Duplicate Lead

Error — Missing Required Field

Error — Unauthorized

Status Codes

Tips

  • Mobile format: Strip all non-digit characters before submitting. The API normalises the field automatically, but sending 555-123-4567 or (555) 123-4567 both work.
  • Deduplication: If deduplication is enabled for the campaign, the isDeDupe flag in the response indicates whether this lead was seen before.
  • Redirect URL: Use redirect_url from the response to forward the consumer to a thank-you page or offer wall.
  • Custom fields: Additional campaign-specific fields (e.g. loan_amount, home_owner) may be required. Check your posting spec for the complete field list.
  • Rate limits: Each campaign source has a configurable rate limit. Exceeding it returns a 429 Too Many Requests response.

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

email
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

isDeDupe
string

Flag for dedup which confirms that lead is duplicate or not

lead_status
string

Current status of lead which can be sold or unsold or new

redirect_url
string

Response Redirect URL of API response

buyer_type
string

Buyer response type for lead sold

buyer_name
string

Current buyer name for lead sold

buyer_response
string

Entire buyer response which we get from buyer's endpoint