Template Variables Guide

Size: px

Start display at page:

Download "Template Variables Guide"

Terence McDowell
5 years ago
Views:

1 Template Variables Guide Prepared By: John Jackson Date: 25 th January 2018 Version: 2.40 Release Page! 1 of 6!

2 Using Template Variables Template variables enable you to add a tag into templates that are replaced at time of processing with information relating to the lead. For example, the tag {LEAD_FIRST_NAME} would be replaced with John when creating an relating to a lead in the name of Mr. John Smith. 1. To use variables, enclose the variable name shown in the table below in { and } tags. 2. If a variable is recognised but has no value, the variable tag will be removed from the processed template. 3. Some variables are replaced at the time of sending, so will appear untouched in processed templates prior to sending. This behaviour is noted in the information below in bold. 4. If the variable tag appears in the processed template, and is not a variable that is replaced at the time of sending, it may not have been recognised so check its format and spelling for errors. Available Variables Variable Name Information PLATFORM_DATETIME Current date & time (i.e. 1st Jan :00) PLATFORM_DATE Current date (i.e. 1st Jan 2009) PLATFORM_DATETIME_FULL Current full date & time (i.e. 1st January :00) PLATFORM_DATE_FULL Current full date (i.e. 1st January 2009) PLATFORM_DATE_SHORT Current dd/mm/yyyy date (i.e. 01/01/2009) PLATFORM_DATE_SYSTEM Current yyyy-mm-dd date (i.e ) PLATFORM_TIME Current 24-hour format time (i.e. 17:00) PLATFORM_NAME PLATFORM_ Main business name Main business PLATFORM_PHONE LEAD_UNSUBSCRIBE LEAD_IPADDRESS Main business phone number unsubscribe link URL (sets 'permission to ' to 'no'). This variable is replaced at the time of sending. IP address associated with the lead LEAD_DATETIME Lead date & time (i.e. 1st Jan :00) LEAD_DATE Lead date (i.e. 1st Jan 2009) LEAD_DATETIME_FULL Lead full date & time (i.e. 1st January :00) LEAD_DATE_FULL Lead full date (i.e. 1st January 2009) LEAD_DATE_SHORT Lead dd/mm/yyyy date (i.e. 01/01/2009) Page! 2 of 6!

3 LEAD_DATE_SYSTEM Lead yyyy-mm-dd date (i.e ) LEAD_TIME Lead 24-hour format time (i.e. 17:00) LEAD_STATUS LEAD_GROUP_ID LEAD_GROUP LEAD_TYPE LEAD_SOURCE LEAD_MEDIUM LEAD_TERM LEAD_COST LEAD_VALUE LEAD_ID LEAD_SUB_ID LEAD_FULL_NAME LEAD_TITLE LEAD_TITLE_NOSTOP LEAD_TITLE_CODE LEAD_FIRST_NAME LEAD_LAST_NAME LEAD_FULL_ADD Lead status Lead group ID Lead group name Lead type name Marketing source Marketing medium Marketing term Total cost of lead Total value of lead Lead reference number Lead sub reference (or appointment) number Customer's full name (i.e. Mr. John Smith) Customer's descriptive title (i.e. Mr.) Customer's descriptive title, without stop character (i.e. Mr) Customer's title code Customer's first name Customer's last name Full concatenated address (i.e. for customer address on letters) LEAD_FULL_ADD_COMPANY LEAD_SHORT_ADD LEAD_COMPANY LEAD_JOBTITLE Full concatenated address (i.e. for customer address on letters), including company name if available Short concatenated address (i.e. 1 High Street SW1 2RE) Company name Job title LEAD_DOB Full date of birth (i.e. 01/01/1990) LEAD_DOB_DAY LEAD_DOB_MONTH LEAD_DOB_YEAR Date of birth day Date of birth month Date of birth year LEAD_PHONE1 Phone number 1 LEAD_PHONE2 Phone number 2 LEAD_FAX LEAD_ Fax number address LEAD_ADDRESS Address line 1 LEAD_ADDRESS2 Address line 2 Page! 3 of 6!

4 LEAD_ADDRESS3 Address line 3 LEAD_TOWNCITY LEAD_POSTCODE LEAD_CONTACT_TIME LEAD_CONTACT_PHONE LEAD_CONTACT_SMS LEAD_CONTACT_ LEAD_CONTACT_MAIL LEAD_CONTACT_FAX LEAD_DATA1 (1 to 50) LEAD_LABEL1 (1 to 50) INTRODUCER_ID INTRODUCER_REF INTRODUCER_NAME INTRODUCER_PAID BUYER_ID BUYER_NAME BUYER_ BUYER_PHONE BUYER_HOURS Town or City Postcode Preferred contact time (i.e. Anytime, Morning, Afternoon, Evening) Phone contact permission Text message contact permission contact permission Mail contact permission Fax contact permission Data provided on lead, corresponding to data field in lead group Data field label corresponding to data field in lead group Introducer ID Introducer/Source Reference Introducer name Amount paid to the introducer Referral partner ID Referral partner name Referral partner customer enquiry address Referral partner customer enquiry phone number Referral partner customer opening hours BUYER_APP_DATE Appointment date (i.e. Mon, 1st January :00) BUYER_APP_NOTES BUYER_REF_TRANS BUYER_REF_XML BUYER_TRANS_DATE BUYER_TRANS_RES BUYER_COST SUB_BUYER_ID1 (1 to 10) SUB_BUYER_NAME1 (1 to 10) SUB_BUYER_ 1 (1 to 10) SUB_BUYER_PHONE1 (1 to 10) Appointment notes Reference number provided by the referral partner if the lead was telephone transferred Reference number provided by the referral partner if the lead was delivered by XML Date and time of referral Result (Successful or Failed) if the lead was telephone transferred Amount paid by the referral partner Referral partner ID (relates to leads sent to multiple buyers) Referral partner name (relates to leads sent to multiple buyers) Referral partner customer enquiry address (relates to leads sent to multiple buyers) Referral partner customer enquiry phone number (relates to leads sent to multiple buyers) Page! 4 of 6!

5 SUB_BUYER_HOURS1 (1 to 10) SUB_BUYER_APP_DATE1 (1 to 10) SUB_BUYER_APP_NOTES1 (1 to 10) USER_ID USER_NAME USER_ USER_PHONE USER_DDI USER_MOBILE USER_FAX USER_JOBTITLE USER_COMPANY USER_ADDRESS USER_SIGNATURE USER_DATA1 (1 to 10) SITE_ID SITE_NAME SITE_ SITE_PHONE SITE_FAX SITE_ADDRESS SITE_DATA1 (1 to 10) COND_NAME COND_COMPANY COND_DOB COND_PHONE1 COND_PHONE2 COND_ COND_ADDRESS COND_ADDRESS2 COND_ADDRESS3 Referral partner customer opening hours (relates to leads sent to multiple buyers) Appointment date (i.e. Mon, 1st January :00) (relates to leads sent to multiple buyers) Appointment notes (relates to leads sent to multiple buyers) Assigned user ID Assigned user name (or site name if over-ridden in user's settings) Assigned user address (or site address if non existent) Assigned user phone number (or site phone number if non existent) Assigned user DDI number (or empty if non existent) Assigned user mobile number (or empty if non existent) Assigned user fax number (or site fax if non existent) Assigned user job title Site name Site address disclaimer text (can be edited in Settings > Configuration> ) Assigned user additional data field (or site additional data field if non existent) Site ID Site name Site address Site phone number Site fax number Site address Site additional data field If exists, outputs customer name after line break If exists, outputs company name after line break If exists, outputs date of birth after line break If exists, outputs phone number 1 after line break If exists, outputs phone number 2 after line break If exists, outputs after line break If exists, outputs address line 1 after line break If exists, outputs address line 2 after line break If exists, outputs address line 3 after line break Page! 5 of 6!

6 COND_TOWNCITY COND_POSTCODE COND_CONTACT_TIME COND_APP_DATE COND_APP_NOTES COND_DATA COND_DATA_ALL If exists, outputs town/city after line break If exists, outputs postcode after line break If exists, outputs preferred contact time after line break If exists, outputs appointment date after line break If exists, outputs appointment notes after line break If exists, outputs lead data labels/values after line breaks (excludes internal fields) If exists, outputs lead data labels/values after line breaks Translating Values It's sometimes necessary to alter values before they are inserted into a template. To do this, add the translations (from=to) into the tag after the variable name, separated by commas. i.e. {VARIABLE,from=to,from=to,from=to,*=to} If no match is found for the value, the original value will be used. The exception is if a wildcard value (denoted by an asterisk *) is found, in which case the wildcard value will be used. The from/to value can be blank, for example {VARIABLE,=Nothing} will match a blank value and replace it with 'Nothing'. For example, if the value in additional field 1 is either 'Yes' or 'No', it can be translated to '1' or '0' before insertion into the template: {LEAD_DATA1,Yes=1,No=0} To make any value other than 'Yes' or 'No' translate to '0', use: {LEAD_DATA1,Yes=1,*=0} Page! 6 of 6!

Lead API Guide Version Lead API Guide. Prepared By: John Jackson Date: 25 th January 2018 Version: 1.50 Release

Lead API Guide Version Lead API Guide. Prepared By: John Jackson Date: 25 th January 2018 Version: 1.50 Release Lead API Guide Prepared By: John Jackson Date: 25 th January 2018 Version: 1.50 Release Page! 1 of 8! Introduction This API allows the reading or deletion of leads. The request is made by making a HTTP