Summary
Learn how third‑party systems pull data from Box+Dice using the Website API and what actions are supported.
This article covers:
Overview
The Website API allows third‑party websites and systems to pull data from Box+Dice, rather than Box+Dice pushing data out.
This distinction is important:
Box+Dice makes data available, but it is the third party’s responsibility to request, store, interpret, and display that data as required.
Types of data exchange enabled through the API
GET requests
- Create Lead Flow Lead
- List all Sales Listings
- List all Rental Listings
- List all contacts
- Retrieve all projects
- Retrieve all property types
- Retrieve all property categories
- Retrieve all other property categories
- Retrieve all suburbs
- List all offices
- List all consultants
PATCH requests
- Update a Sales Listing
- Update a Rental Listing
- Update a Contact (permit/deny email Blast and SMS permissions )
- Update a Contact (add a 'Web Enquiry' category against specified consultant)
- Update Search Criteria
POST Requests
- Create a Contact
- Create a Contact category
- Create a Contact Note (create a note on timeline when firstname, lastname, email or mobile has changed)
- Create an Enquiry (add a buyer lead to a listing. This can also create a new contact if not already existing)
- Create Search Criteria (matching criteria)
DELETE Requests
Delete Search Criteria
For example, an API call can include the 'hidden' tag value, however, the ‘Hide’ button doesn’t change the number of listings the 3rd Party can see (it simply adds the value of the tag as 'false' or 'true')The 3rd Party can choose what they will do with such values of that flag.
What's next?
Learn how third‑party systems interact with the Box+Dice Website API.