The Integrate Demand Acceleration Platform allows you to automate your lead uploads into an Integrate Source via API.
This article includes these sections:
Lead Upload via API Instructions
To prepare to configure your API within any system, you'll first need to gather the API details from the specific Source within the Integrate Demand Acceleration Platform.
Please Note: Each Integrate Source has a unique API endpoint.
Navigate to the corresponding Integrate Source and scroll to the bottom to locate the Delivery section.
Your POST API can be constructed in either URL Encoded or JSON so both are provided for each Integrate Source and example values of each are shown below.
Locate yours within the corresponding Integrate Source and use that to configure the set-up of your API.
URL Encoded Example:
POST https://api.integrate.com/post/52117728-34c7-4ded-bb42-981d086956fe HTTP/1.1
Content-Type: application/x-www-form-urlencoded
FName=myValue&LName=myValue&Email1=myValue&Phone1=myValue&Title=myValue&Address1=myValue&Address2=myValue&City=myValue&Zip=myValue&State=myValue&Country=myValue
JSON Example:
POST https://api.integrate.com/post/52117728-34c7-4ded-bb42-981d086956fe HTTP/1.1
Content-Type: application/json
{
"FName": "myValue",
"LName": "myValue",
"Email1": "myValue",
"Phone1": "myValue",
"Title": "myValue"
"Address1": "myValue"
"Address2": "myValue",
"City": "myValue",
"Zip": "myValue",
"State": "myValue",
"Country": "myValue"
}
Lead Upload via API Videos
Two of the most common API builders used by media partners are Zapier and Postman. So we've created instructional videos to help guide you through set up within those systems.
For additional assistance with configuration or troubleshooting within those 3rd party platforms, please contact their support teams.
Delivering Leads via API - Zapier
Delivering Leads via API - Postman
API Callback Responses
Once data is being posted into an Integrate Source via API, there are 2 callback responses can be provided.
The first callback response is for the creation of the record in the source.
- A successful response will contain the leadID created by Integrate’s DB:
{
"result": [<UNIQUE_GUID_OF_NEW_LEAD>, ...],
"error": []
}
- An error response will look like the information below, along with the corresponding error code:
{
"result": {},
"error": "An error has occurred!"
}
Once the record has been created in the platform, a second callback response can be provided to show if the lead has been Accepted, Rejected, or Failed.
However, the endpoint should be provided in the POST URL and should accept a JSON POST request. Included below is the example of the format for the request.
POST https://api.integrate.com/post/52117728-34c7-4ded-bb42-981d086956fe?callback=[address here] HTTP/1.1
Content-Type: application/x-www-form-urlencoded
FName=myValue&LName=myValue&Email1=myValue&Phone1=myValue&Title=myValue&Address1=myValue&Address2=myValue&City=myValue&Zip=myValue&State=myValue&Country=myValue
Please Note: This address is called anytime the status of a lead they posted in changes, so it can be called multiple times over the life of the lead.
The body of the message we send is of type 'application/json' and looks as shown:
POST [callback address provided] HTTP/1.1
Content-Type: application/json
{
“Id”: <ORIGINAL GUID OF LEAD>,
“Status”: <ONE OF STRING>”accepted”, “rejected”, “failed”,
“Reason”: <ADDITIONAL INFORMATION RELATED TO THE STATUS STRING>,
“Timestamp”: <ISO 8601 UTC DATE STRING>,
"Code": <ONE OF DISPOSITION CODES> (ex. "SUCCESS", "POSTOUT_SUCCESS",
"REJECT_INVALID_EMAIL", etc.)
}
Full Request Example:
POST http://somewhere.com/my/lead/status HTTP/1.1
Content-Type: application/json
{
“Id”: “6953f82c-292e-47a6-989e-2de5b7d4e9a7”,
“Status”: “rejected”,
“Reason”: “Address validation failed”,
“Timestamp”: “2017-01-16T23:55:32+00:00”,
"Code": "SUCCESS"
}