Offer Campaign APIs
Create Form API
The Create Form API is designed to enable seamless lead form creation and submission. It is ideal for capturing user data directly from landing pages or campaign websites, ensuring that lead information is collected accurately and efficiently.
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
{source-unique-id} with the unique link ID assigned to your campaign source (found in your posting spec).
Authentication
Include your API token in theAuthorization header:
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-4567or(555) 123-4567both work. - Deduplication: If deduplication is enabled for the campaign, the
isDeDupeflag in the response indicates whether this lead was seen before. - Redirect URL: Use
redirect_urlfrom 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 Requestsresponse.
Body
application/json
Lead details to add to the campaign
Response
Lead successfully updated