Summary
Learn how to create buyer leads in Box+Dice using the Enquiries API, including retrieving listing IDs, creating contacts, and submitting buyer enquiries to the CRM.
How it works
The Enquiries API allows external systems, portals, and CRMs to create buyer enquiries directly in Box+Dice.
To successfully create a buyer lead, the process requires:
- A valid sales_listing_id
- A contact record
- A completed buyer enquiry submission
Before creating a buyer enquiry, you must identify the sales_listing_id.
This step is only required if the listing ID is not included in the Portal Upload XML (AgentPoint XML feed format).
cURL example
curl --location --request GET 'https://beta.boxdice.com.au/enquiry_api/sales_listings' \
--header 'Authorization: Api-Key token=XXXXXXXXXXXXXXXXXXXXXa7ab6' \
--header 'Content-Type: application/json' \Postman example
CRM example
Once the sales_listings_id is acquired, you can now create the contact.
cURL example
curl --location 'https://beta.boxdice.com.au/enquiry_api/contacts' \
--header 'Authorization: Api-Key token=XXXXXXXXXXXXXXXXXXXXXa7ab6' \
--header 'Content-Type: application/json' \
--data-raw '{
"contact": {
"first_name": "John",
"last_name": "Smith",
"mobile": "0404111222",
"email": "john.smith@example.com"
},
"consultant_id": 2
}'Postman example
CRM example
Now that you have the sales_listings_idand the contact_id,you can POST the enquiry to the CRM.
cURL example
curl --location 'https://beta.boxdice.com.au/enquiry_api/sales_listings/827/buyers' \
--header 'Authorization: Api-Key token=XXXXXXXXXXXXXXXXXXXXXa7ab6' \
--header 'Content-Type: application/json' \
--data '{
"buyer": {
"contact_id": 16703,
"consultant_id": 22,
"interest_level": "ENQUIRY",
"date_inspected": "2025-02-04",
"source_id": 12
}
}'Postman example
CRM example
The Box+Dice API follows a two-step interaction model designed to ensure up-to-date and consistent data access.
To begin, clients must initiate a GET request to retrieve and store relevant information from the appropriate endpoint. This data—such as IDs or entity details—is then cached or saved by the client application for future use.
Many subsequent API calls require referencing this previously retrieved data. For example, actions like posting an enquiry or updating a listing may require an agent ID or listing ID obtained during the initial GET request.