API Documentation

The below instructions should be paired with your specific Big Purple Dot API keys.

The standard way we gather lead information is via a posting URL, which requires a unique username and secret key, which you can find within your Big Purple Dot account under Settings > CRM > API Information

Below you'll find the fields required for a successful post. Also, the request should be sent via HTTPS POST request using JSON.

The URL it should be posted to is: https://bigpurpledot.com/api/v1/contacts/vendor_create.json

We will reply with a 200 response on a successful post.

 

The example curl is:

 

curl -X POST "http://bigpurpledot.com/api/v1/contacts/vendor_create.json" -H 'Content-Type:application/json' -d '{"first_name":"Joe","last_name":"Test","phone":"8005889336","email":"[e-mail]","credit_history":"Good","property_street":"123 Testing Dr","city":"Costa mesa","state":"CO","zip":"92627","property_type":"","notes":"Test","api_user":"joetestuser2323","api_secret":"54383165c1d0f4813c"}'

Should you need any help posting leads or are receiving error codes, please feel free to reach out to our team at [e-mail]

*For Zillow and Lending Tree please reach out to our Support Team for specific posting URL and guidelines.