Note: This tab is available in Custom Source (CS), Media Channel (MC), and Marketing Partner (MP) source types.

The Form API tab provides everything needed to configure and manage server-to-server lead delivery from a traffic source into Pingtree.

​
What is the Form API?

If you’re working with a traffic source that sends leads directly to your web property, you’d typically use a direct or redirect tracking link.

However, if the goal is to send lead data from an external system (like a landing page, CRM, or third-party form) directly into your Pingtree campaign, you’ll use the Form API. This setup enables lead data to be transferred securely via server-to-server communication.

​
Form API URL (Endpoint)

The API URL serves as the endpoint where the traffic source submits lead data. This URL must be installed and used by the source sending the data to ensure it’s received properly by Pingtree.

​
Generate Authorization Token

To allow a traffic source to post lead data, you need to generate an Authorization Token. Simply click the “Generate New Token” button next to the API URL.

Important: A new token is generated every time this button is clicked. If you’ve shared an existing token with a source and then generate a new one, they must update the token on their end with the new value.

​
Authorization Token Details

  • This token is a Bearer Token.
  • The traffic source must send it in the request header using the following format: Authorization: Bearer {your_token_here}
  • Be sure to include the word Bearer followed by a space before the token value.

​
API Request Types

Pingtree supports two types of API requests:

  • GET Request
  • POST Request (Preferred: must use raw JSON format)

If the source is using a POST request, they must ensure the data is formatted correctly as raw JSON in the body of the request.

​
API Response Codes

Pingtree provides various response codes to indicate whether the system accepted or rejected the lead data.

These codes may reflect:

  • Successful receipt
  • Invalid or missing fields
  • Invalid token
  • Incorrect data format

These responses help the traffic source debug issues and ensure smooth lead transmission.