When using BDP Command to send emails you can include almost any data contained in BDP in the email template. The same is true for Word document templates.

Developers will also want to make use of this data which is all available via the API. There are additional items available, however because they are not commonly used they have been excluded from this list. Please contact us if you don’t see an item you require.

What follows is a complete listing of all system “hooks” for properties.

The full email placeholder will be in the form {{ propertyDetails.placeholderName }} and the full Word document placeholder will be in the form [var.propertyDetails.placeholderName]

Property placeholders

[descText] Full description
[epcBand] EPC band letter
[cTaxBand] Council tax band letter
[gardenType] Garden type, eg. Front, surrounding, etc.
[parkingType] Parking type, eg. Garage, off-street, etc.
[tenureType] Tenure, eg. Freehold, leasehold
[summaryText] Property summary from Property Details widget
[viewingDetails] Viewing details, eg. By appointment with agent, etc.
[espcSlogan] ESPC slogan
[genNotes] Contents of the Notepad widget. NOTE: Do not send outside your organisation!
[localRef] Firm’s internal property reference
[viewingMInfoviewingMInfo] Viewing Management info from the management widget
[keyMInfo] Key management info from the Management widget
[signMInfo] Sign management info from the Management widget
[surveyorName] Surveyor name
[surveyorInstructions] Surveyor instructions
[espcId] ESPC ID (integer). Can be used to build a URL to link to the property on ESPC
[escpHrId] ESPC Home Report ID (integer). Can be used to build a link to the ESPC home report.
[shMovieLink] Full URL to Shoot Home video
[addrL3] Address line 3
[paperAddress] Address displayed in the ESPC newspaper.
[branch_id] Branch ID (integer). Could be used as part of a URL to display properties from a particular branch.
[property_id] BDP property ID (integer). Can be used as part of a URL to link to the property.
[houseNo] Number or name of property
[streetName] Street or road name
[pName] Property name
[addrL1] Address line 2 (line after the street name)
[addrL2] Address line 3
[town] Town or city
[postcode] postcode
[formatAddress] Concatenated “display” address comprising all separate address fields.
[dispAddress] The Display address if this has been entered into the separate display address field
[lat] GPS Latitude of property
[lng] GPS longditude of the property
[mapData] Map data – call for details
[askingPrice] Asking price (integer). Unformatted.
[sqmHouse] Floor area of the house in square metres
[sqmLand] land area in square metres
[bedRooms] Number of bedrooms (integer)
[livingRooms] Number of living rooms (integer)
[bathRooms] Number of bathrooms (integer)
[garden]
[noShowerRooms] Number of shower rooms (integer)
[noKitchens] Number of kitchens (integer)
[noToilets] Number of toilets (integer)
[espcDistrict] ESPC district
[pLive] Property live (integer)? 1=yes, 0=no
[typeNames] Property type name (array so can be more than one). Example usage {{ propertyDetails.typeNames.0 }}
[letFrequency] Let frequency (Lettings only)
[detailPath] Full URL to property on firm’s website if using the jQuery method. NOTE: Will not work if using the API
[sellingStatus] Selling status, e.g. Available
[statusClass] CSS class for selling status can be used to style different selling statuses
[currencySymbol] Currency symbol, e.g. £
[onlineStateLabel] Online state, e.g. Online

Document placeholders

[brochurePathPublic] Full path to the brochure including http.
[epcDocPathPublic] Full path to the EPC document including http.
[floorPlanPdfPathPublic] Full path to the PDF floorplan including http.
[hrPathPublic] Full path to the Home Report including http.
[brochure] File name of brochure (schedule). Note: Not full URL.
[fPlan] File name of JPEG floor plan
[fPlanPdf] File name of PDF floor plan
[hReportPdf] File name of Home Report PDF

Price placeholders

[hrValue] Home Report value as an integer (no currency symbol or formatting)
[priceType] Price type, e.g. Fixed, Offer over, etc.
[outputSoldPriceCMS] Sold price, fully formatted including currency symbol.
[hrValueFormat] Home report value, formatted including currency symbol
[outputAskingPrice] Fully formatted asking price with currency symbol and thousands separator
[floatAskingPrice] Unformatted asking price (integer)
[outputHrValue] Fully formatted home report value with currency symbol and thousands separator => £425,000
[priceTypeLabel] Price type label, e.g. Fixed Price

Date placeholders

[entryDate] Entry date
[hrPDate] Home report published date. Formatted date
[dateListed] Property listing date in Unix time
[closingDateFormat] Closing date, formatted.
[closingDate] Closing date in Unix time format (see http://i.bdphq.com/email-date-placeholder-formats/)
[gasSafetyFormat] Gas safety certificate due date, formatted
[marketDateFormat] Date property came on market, formatted, e.g. 15 Nov 2013
[marketDate] Market date in Unix time format (http://i.bdphq.com/email-date-placeholder-formats/)

Statistics

Use: {{ propertyDetails.stats.arrayPlaceholder }}
[stats] Array

[notesInterest] Number of notes of interest (integer)
[offersLogged] Number of offers logged (integer)
[closingDate] =>
[gasSafety] =>
[workOrders] Number of work orders (integer)
[noViewings] Number of viewings (integer)
[dRequestsOffice] Number of details requests via the office (integer)
[dRequestsWebsite] Number of details requests via your website (integer, only available if using the jQuery snippet)
[dRequestsRM] Number of details requests via Rightmove (integer)
[dRequestsZoopla] Number of details requests via Zoopla (integer)
[dRequestsS1] Number of details requests via S1 (integer)
[dRequestsESPC] Number of details requests via ESPC (integer)
[hrRequestsESPC] Number of home report requests via ESPC (integer)
[hrRequestsOffice] Number of home report requests via the ofice (integer)
[setOnline] Date property set online in Unix time format

The following can be used directly without calling the array first:

Images

Use: {{ propertyDetails.images.0.url }}
First image ID is 0, then 1, 2, etc.
[images] Array
[0] Array

[timeOnMarket] Time on the market in weeks and days, e.g. 50 weeks, 3 days
[soldDateFormat] Sold date, formatted
[featureList] List of features
[espcExpiryFlag] ESPC expiry date, HTML formatted, e.g.

20 Nov 2113
[notesInterest] Number of notes of interest (integer)
[offersLogged] Number of offers lodged (integer)
[url] Full path to image including http. e.g. https://bdphq.com/?bdimg=13824_52_1384255198.jpg
[created] Image creation date in Unix time format

The following can be used directly without calling the array first:

[imagePath] File name of the primary image (not full path)

Rooms

Use: {{ propertyDetails.rooms. }}
[rooms] => Array

Staff data

Use: {{ staffData.staffArrayField }}

[staffData] => Array
(
[staff] => Array

[user_id] =>
[userNme] =>
[firstName] =>
[lastName] =>
[workTel1] =>
[workMob1] =>
[workRole] =>
[proPic] =>
[initials] =>

[negDetails] Array of negotiator details

[userNme] BDP user name is the full email address
[firstName] First name
[lastName] Surname
[workTel1] Work telephone number
[workMob1] Mobile number
[workRole] Work role, e.g. Property Negotiator
[proPic] Staff photo filename (not path), e.g. proPic_1372271133.jpg
[initials] Initials
[valuerDetails] Array of valuer details

Placeholders as per Negotiator

[convDetails] Array of Conveyancer details

Placeholders as per Negotiator

[ccareDetails] Array of client care details

Placeholders as per Negotiator

[feeEarnerDetails] Array of fee earner details

Placeholders as per Negotiator

[solDetails] Array of solicitor details

Placeholders as per Negotiator

[adminDetails] Array of administrator details

Placeholders as per Negotiator

[userData] Array of currently logged-in user details

Placeholders as per Negotiator

Leave a Reply

Your email address will not be published. Required fields are marked *