Skip to main content

​
Overview

Pingtree includes a standard set of lead fields out of the box — name, email, phone, address, and other common identifiers. Custom Fields let you go beyond these defaults by defining additional data points specific to your vertical, advertiser requirements, or internal workflows. Custom fields can be used for data capture, import mapping, export filtering, and campaign-level field management.
Custom Fields list with field names, data types, and status toggles

​
Default vs. Custom Fields

TypeDescription
System FieldsBuilt-in fields provided by Pingtree (e.g., first_name, email, phone, state, zip). These are available to every source by default.
Organization Custom FieldsFields created by your organization that are available across all database sources and campaigns.
SubID FieldsSpecial tracking fields used to capture affiliate sub-parameters for attribution and reporting.

​
Supported Field Types

When creating a custom field, choose the data type that matches the values you expect to collect:
Field TypeDescriptionExample Values
TextFree-form string input."Homeowner", "Interested in solar"
NumberNumeric values, integers or decimals.42, 3.14
DateDate values in standard formats.2025-06-15
DropdownA predefined list of selectable options."Yes", "No", "Maybe"
BooleanTrue or false values.true, false

​
Creating a Custom Field

  1. Navigate to the Custom Fields tab within your database source (or via the organization-level field settings).
  2. Click Add Custom Field.
  3. Fill in the field details:
SettingDescription
Field NameThe display label for this field (e.g., “Annual Income”).
Field KeyThe API key used to submit or retrieve this field (e.g., annual_income). Auto-generated from the name.
Field TypeSelect the data type: Text, Number, Date, Dropdown, or Boolean.
RequiredToggle on to make this field mandatory for lead submission.
Dropdown OptionsIf the field type is Dropdown, define the list of allowed values.
  1. Click Save.
Tip: Field keys should be lowercase and use underscores instead of spaces. They are used in API payloads and CSV column headers, so consistency matters.

​
Marking Fields as Required or Optional

Any field — system or custom — can be set as required for a specific database source. When a lead submission is missing a required field, it is rejected at ingestion time with a clear error message indicating which field is absent. To update a field’s required status:
  1. Go to the Custom Fields tab.
  2. Find the field you want to update.
  3. Toggle the Required switch on or off.
  4. Save the change.

​
Enabling and Disabling Fields per Campaign

Custom fields can be enabled or disabled at the campaign level. This lets you collect different data points depending on which campaign a lead flows through. To manage field availability per campaign:
  1. Open the campaign linked to your database source.
  2. Navigate to Settings > Field Management.
  3. Toggle each custom field on or off for that campaign.
Tip: Disabling a field at the campaign level does not delete the field or its data — it simply stops the field from appearing in the campaign’s form API spec and submission validation.

​
Click Script Fields

Click Script fields are a special category of custom field that capture data points via JavaScript tracking embedded on your landing pages or thank-you pages. These fields are populated client-side when a visitor interacts with your funnel, and the values are passed along with the lead submission. Common uses include:
  • Capturing the click ID from an ad network.
  • Recording the time spent on a page before conversion.
  • Storing the referring domain or UTM parameters.
To set up a click script field:
  1. Create the custom field and mark it as a Click Script field type.
  2. Configure the JavaScript variable or DOM element selector the script should read from.
  3. The click script will automatically populate the field value at submission time.

​
SubID Fields

SubID fields are dedicated tracking parameters used by affiliate traffic sources (Marketing Partners) to pass sub-account or campaign-level identifiers alongside a lead.
SubID FieldDescription
SubID 1–5Standard affiliate sub-parameters for tracking traffic split by ad, placement, or creative.
Custom SubIDOrganization-defined sub-parameter keys for more granular tracking.
SubID values appear in the SubID Report and can be used to analyze performance at the sub-publisher level.

​
Mapping Custom Fields for Import and Export

When uploading leads via CSV, the column headers in your file must match either the field key of a system field or the field key of a custom field. During the import step, Pingtree’s column mapper shows all available system and custom fields so you can align your CSV columns correctly. For exports, all custom fields are included in the exported CSV alongside system fields. You can filter which fields appear in the export from the export settings. See Data Importer for the step-by-step import process.