Email Merge Tags

This page is now maintained in our Spaces document, here:


Odyssey has many fields which can be incorporated directly within your email template, or they can be used when creating 'rules' for elements within your email.  Eg: When to show/hide pictures or text.  Listed below are the names of the merge tags you can utilise within the various CRM email messages you construct in MailJet.





Merge tags available for any Client facing emails

Merge Tag Description Example
 {{var:L1Code:""}} Short code for the eg: 'Category' relating to the 'Booking' for this 'Client'.  This is mainly used to format 'hide/show' rules within an email.  Allowing for relevant pictures and text to display. e.g. A2O
{{var:L1Description:""}} The description of this L1, eg: 'Category' or Trail or Country,  e.g. Cycling, Hiking, Alps to Ocean, England.
{{var:CoyCode:""}} This is generated by Odyssey, and is the short code for your company NTEX
{{var:L1Location:""}} Usually a single word for the eg: town/city when used to construct dynamic sentences within the email. This field comes from the L1/Depot/City field. , Twizel



{{var:L2Code:""}} Short code for the eg: 'Trip Master' CW1
{{var:L2Description:""}} The description of this eg: 'Trip Master' Cumbrian Way 5 Day
{{var:MeetsMinPax:""}} The minimum 'Booking' numbers have been meet.  1 = This 'Departure' will proceed. 0 = Does not meet min Pax required.  Used so that a MailJet condition can test if the min pax number has been met.   1
{{var:L2Code2Char:""}} This variable is specifically designed to make email content available to all trips based on the first TWO characters of a Master trip code CW
{{var:L3Code:""}} The short code for this eg: 'Departure' 25CW1J15
{{var:L3Description:""}} The description for this 'Departure' BARKER, Michael Tour
{{var:L3Time:""}} A Time value to include in messaging.  (This is not the briefing time field, but a separate field on the Departure | Email | Service Content page)
{{var:L3Start:""}} A short description of the Start of the 'Departure', from the Email Comms tab. Typically a 'large text block' for DESCRIBING the location and what to expect regarding the Starting of the trip.  Departure | Emails | Service | Start Christchurch
{{var:L3Grading:""}} A description of the Grading of this 'Departure'.  Departure | Emails | Service | Grading This will contain any long text entered into this field
{{var:L3Meeting:""}} A block of text describing the meeting location for the 'Departure'.  Departure | Emails | COMMS Content | Start/Meeting Service | Meeting This will contain any long text entered into this field
{{var:L3End:""}} Descriptive details about where a Departure ends.  Departure | Emails | Service | Meeting Time Queenstown
{{var:L3PaxList:""}} A list of First and last names of the 'Clients' on this 'Departure'

Mary

Jack

Alister

Michael

{{var:L3AssetList:""}} This lists the Models of bikes which have been allocated to clients within a Departure/Trip

e-Bike

Own Bike

Discovery

{{var:L3Commission:""}} The total of all Commission values for this Trip/Departure

The Net Value of this Trip/Departure, after Commission has been deducted
{{var:L3PAX:""}} A Count of the total PAX/'Clients' on this 'Departure' 4
{{var:L3GuideList:""}} A list of Guide names assigned to this Departure, including their mobile number if that is entered
{{var:OdyTripsRef:""}} The Reference to use in the Ody Trips App 15442
{{var:L3Duration:""}} The number of days of the Departure. Note this does not include prior days 5
{{var:L3Region:""}} The Region of this Departure, from the Departure | Daily Location | Itinerary | Region/Province/Territory field Otago
{{var:L3Routes:""}} The Daily locations directions map pin button for containing links inks for Ride with GPS, must say https://xxxxx.xxxx./xxx
{{var:L3PAXBooked:""}}

A count of Passengers actually booked with this Provider (not Tour PAX count)


April 25.  Check this, I think there is another newer one which has been tested.  

3
{{var:L3Inclusions:""}} Adds the Tour | Details | Inclusions text This will contain any long text entered into this field
{{var:L3Type:""}}

From the Departure | Details | Details | Departure type field.  Especially good for setting conditional sections.  

Tested in DEMO 11 March.  successful.  

Cycling, Hiking, Package, Self Guided.   
{{var:L3Status:""}}

Added Mar 1, not yet tested.

Tested in DEMO 11 March.  successful. 

Confirmed, Active, Cancelled

{{var:L4Status:""}}

Booking status of the Client

Tested in DEMO 11 March.  successful. 

Agent, Confirmed, On Hold.  
 {{var:L4Ref:""}} 'Booking' Reference, for this 'Client' for their 'Booking' 122653
{{var:L4FreeText1:""}} Free flow text (From field on Booking | Details | Sharing Freeflow text 1 field.  The button on the right populates this field) This will contain any long text entered into this field
{{var:L4FreeText2:""}} Free flow text (From field on Booking | Details | Sharing Freeflow text 2 field.  The button on the right populates this field) This will contain any long text entered into this field
{{var:L4FreeText3:""}} Free flow text (From field on Booking | Details | Sharing Freeflow text 3 field.  The button on the right populates this field) This will contain any long text entered into this field
{{var:PayerDeposit:""}} The amount of money paid by this Client either for themselves, or all the clients they are paying for
{{var:L4BalancesList:""}} The amount of money owed by all clients on this trip

Mandy Barker [ 311.00 ]

Andy Barker [ 0.00 ]

Callum Barker [ 0.00 ]

{{var:L4PaymentsList:""}} A list of the Names and total amounts which have been paid to date
{{var:L4Payments:""}} The total of all Payments made/entered to date for this 'Client' for their 'Booking'
{{var:L4AssetAllList:""}} this will display each client’s name and the Bike, Extras & Accessories that have been allocated to them. 

Mandy B [ e-Bike, Gel Seat Cover, Chilly Bin, Helmet, Helmet - Own, Pedals - Flat (Specialised) ]

Andrew B [ e-Bike, Gel Seat Cover, Chilly Bin, Helmet, Helmet - Own, Pedals - Flat (Specialised) ]

{{var:L4BalOwingPayer:""}} The Balance Owing by this 'Client' for all of the 'Bookings' combined, where this client has been defined as the Payer 311.00
{{var:PayerAllCosts:""}} The sum of all costs relating to all 'Clients' being paid by the allocated Payer
{{var:FirstName:""}}

The First name of the 'Client'. NOTE: If a preferred name has been entered, Odyssey will do a calculation and 'fill-in' the Preferred name.

This field can be added onto the button for the Cognito Forms Client Details link. An update to the script for this merge tag may need to be pushed to older client Ody files to allow this.

Mary
{{var:LastName:""}} The Last name / Surname of the 'Client' Jones
{{var:IntroText:""}}

Freeflow text entered entered at the time of sending the email, to allow for personalised or client specific comments prior to the generated email being sent.   This block of text should sit at the beginning of constructed email.


**Tanya recommends that the Intro and Footer text blocks remain in every email template at all times. The reason for this is that we cannot control whether a user enters text in either or both sections. If one or both blocks are removed from the email, there will be no visual indication within Odyssey to guide users on which one to use. This could lead to important text not being included in the email without the user realizing it, which poses a risk and is not a best practice in terms of design and functionality.

This will contain any long text entered into this field
{{var:FooterText:""}} Freeflow text entered entered at the time of sending the email, to allow for personalised or client specific comments prior to the generated email being sent.   This block of text should sit at the end of constructed email This will contain any long text entered into this field
{{var:Height:""}} The height of the 'Client' 165
{{var:AssetName:""}} Description of the [ eg: Bike / Kayak ] being hired e-Bike Low Step
{{var:L4Room:""}} 'Booking' Room preference for this 'Client' for their 'Booking'  Used by our customers who use Generic Accommodation types, set on the Booking | Details | Sharing tab
{{var:SharingWith:""}} A list of names this person is sharing a room with Andy Barker
{{var:PayerName:""}} The name of the Payer for this booking
{{var:PayeeList:""}} A list of names the payer is paying for
{{var:L4RoomingList:""}}

Client Room Sharing list

STILL TO COME tested 2 April, not working



Client Accommodation Generic Selections
{{var:L4Organiser:""}} The Departure/Tour organiser indicated on each Tour; this mergetag should only be used where our clients indicate ONE organiser per tour, not multiple 1
{{var:L4AllCosts:""}} All costs for this tour for this one booking
{{var:L4CommsList:""}} for use with clients using Cognito Forms. This merge tag produces a list of Client Names (where known) and adds a list of hyperlinks to the MailJet template, where the "organiser" receives a list of those clients on their email template and can populate their guests names and email addresses. For this conditional section to appear, the rule requires L4CommsTest rule to be in place, as below.

User uploaded image

{{var:L4CommsTest:""}} This is mergetag field required for the Conditional Rule, to make the section containing the L4CommsList appear or not appear. field 67. Show this section If L4CommsTest does not equal hide
{{var:L4RoomSummary:""}} A summary of the specific rooms requested and a count of them
{{var:L4RoomingSelections:""}} A list of each specific room type booked, with the name of the client/client's sharing that specific room
{{var:L4PayerNamesKXY:""}}

showing the equipment hired by the PayeeList

= Bike

X = Extras

Y = Accessory

And these are the details of all of the client being paid for by one person..

Added March 25,  Not yet successfully tested.  See #4331


{{var:CreditCardPercent:""}}

taken  from the company finance settings?

add the character "%" in the email body text.

11 March 25 Tested in DEMO, successful. 



eg: 2.35


{{var:AgeAlert:""}}


Used to include a section if the client age is over a certain value, so that additional content can be added to email template, e.g. over 75, a Medical Certificate would be required.


This merge tag works by

a) Based on Settings | Client settings | Age Alert Field   e.g. 75

b) the client's DOB needs to be over 75 at the start of the tour.   You will see this on the Tour | Booking | Personal | Medical tab | Age at Tour 'start field' will have an age calculated based on their DOB and Tour start date.  An (!)alert will show if over the settings in a) 


If the email template has a conditional text section which says "Show this field if AgeAlert=1", then the text will be included.  


17 March 2025, tested in DEMO, good.

e.g. 75

there may need to be a hide/show rule here to make the AgeAlert merge tag a conditional section
{{var:BalDueDateLong:""}}

This was requested to be a long date field, created by

  • Tour start date {{var:L3Start:""}}
  • MINUS
  • the Balance due figure selected in Finance Default Settings #1

11 March 25, tested in DEMO, it works, but result is not long date field, it's 19/03/2024


On  16 March in DEMO this mergetag was renamed to {{var:BalDueDateLong:""}} from {{var:BalDueDate:""}} and has yet to be retested

e.g. Tuesday, 19 March 2024


{{var:BalDueDateLongUSA:""}}

as above, but in US Date format

in DEMO only


{{var:L5DietaryList:""}} A list of dietary requirements of each client

Mandy Barker: Vegan Dairy Free

Andy Barker: None 

Callum Barker: Vegetarian

{{var:Country:""}} 'Client's' country New Zealand
{{var:PayeeListValues:""}} For the PAYER, this is a list of each PAYEE'S grand total costs (at the start of the trip) (not balances)






{{var:DateStart:""}} The date this 'Departure' will START 26/5/2025
{{var:DateEnd:""}} The date this 'Departure' will END 2/6/2025
{{var:DayDateEnd:""}} The 3 letter version of the Day of the week for DateEnd,  eg; 'Tue' or 'Thu"; only the day is meant to show
{{var:DateDay1:""}} The date of Day ONE for this 'Departure'.  The day of the week will not be used.   26/5/25
{{var:DayDay1:""}} The 3 letter version of the Day of the week for DateDay1,  eg; 'Tue' or 'Thu"
{{var:DayDateStart:""}} The 3 letter version of the Day of the week for DateStart,  eg; 'Wed' or 'Thu"
{{var:DateDay1USA:""}} The date of Day ONE in USA format for this 'Departure'.  The day of the week will not be used.   5/26/25
{{var:DateStartUSA:""}} DateStartUSA - The date in USA format this 'Departure' will START 5/26/2025
{{var:DateEndUSA:""}} DateEndUSA - The date in USA format this 'Departure' will END 6/3/2025

{{var:DateStartLong:""}}


Start Date of the Tour 

11 March 2025 tested in DEMO, successful

Monday, 26 May 2025

{{var:DateEndLong:""}}


End Date of the Tour

11 March 2025 tested in DEMO, successful

Tuesday, 3 June 2025

{{var:DateStartLongUSA:""}}


Start Date of the Tour in US format

11 March 2025 tested in DEMO, successful

Monday, May 26, 2025
{{var:DateEndLongUSA:""}}

End Date of the Tour in US format

11 March 2025 tested in DEMO, successful

Tuesday, June 3, 2025
{{var:L4RegoFormList:""}}

For guides etc to see who has completed the equipment waiver form?

30 March 2025

not yet tested by Claire

Marcus Patterson [ Yes ]
Al Pacino [ No ]



{{var:StaffEmail:""}} StaffEmail - The Email of the signed in staff member 
{{var:StaffFirstName:""}} StaffFirstName - The First Name of the signed in staff member 
{{var:StaffLastName:""}} StaffLastName - The Last Name of the signed in staff member 
{{var:StaffDepartment:""}} StaffDepartment - The Department of the signed in staff member 




Merge tags available for Provider emails




{{var:IntroText:""}} Freeflow text entered entered at the time of sending the email, to allow for personalised or client specific comments prior to the generated email being sent.   This block of text should sit at the beginning of constructed email Free flow text field
{{var:FooterText:""}} Freeflow text entered entered at the time of sending the email, to allow for personalised or client specific comments prior to the generated email being sent.   This block of text should sit at the end of constructed email Free flow text fiel
{{var:CoyCode:""}} This is generated by Odyssey, and is the short code for your company
{{var:L1Code:""}} Short code for the eg: 'Category' relating to the 'Booking' for this 'Client'.  This is mainly used to format 'hide/show' rules within an email.  Allowing for relevant pictures and text to display. A2O
{{var:L1Description:""}} The description of this eg: 'Category'  Alps to Ocean
{{var:L2Code:""}} Short code for the eg: 'Trip Master' A2OE
{{var:L2Description:""}} The description of this eg: 'Trip Master'  A2O Express
{{var:L3Description:""}} The description for this 'Departure' MARLEY Bob's Adventure
{{var:L3Code:""}} Short code for this eg: 'Departure'
{{var:L3PStatus:""}} Provider Task Status eg: 'Confirmed', 'Waitlisted', 'Cancelled'
{{var:DateStart:""}} The date this 'Departure' will start
{{var:DayDateStart:""}} The 3 letter version of the Day of the week for DateStart, eg; 'Wed' or 'Thu"
{{var:ProviderName:""}} Provider Company Name
{{var:ContactName:""}} Provider Contact Name
{{var:DateAtProvider:""}} The actual date Booked at this Provider
{{var:DayDateAt:""}} The 3 letter version of the Day of the week for DateAtProvider, eg; 'Wed' or 'Thu"
{{var:DateAtLong:""}} Long Date Format. Used with DateAtCheckOutLong to show the Provider in one email what date the client checks in, and then out, so no need to send multiple emails to the provider if the client is staying for multiple days displays the Full Month Name 
{{var:DateAtLongUSA:""}} Long Date Format. Used with DateAtCheckOutLong to show the Provider in one email what date the client checks in, and then out, so no need to send multiple emails to the provider if the client is staying for multiple days Sunday, October 5 2025
{{var:DateAtCheckOut:""}} Used with DateAtLong to show the Provider in one email what date the client checks in, and then out, so no need to send multiple emails to the provider if the client is staying for multiple days
{{var:DateAtCheckOutLong:""}} Long Date Format. Used with DateAtLong to show the Provider in one email what date the client checks in, and then out, so no need to send multiple emails to the provider if the client is staying for multiple days
{{var:CheckOutTime:""}} Provider Check out time
{{var:ProductTime:""}} Provider Check in time
{{var:Season:""}} Used with 'Combined' Departures for a selected Season
{{var:ProviderRef:""}}

{{var:RoomsRequired:""}}

MergeTag: RoomsRequired = L4 level Generic Accomm selections, shown as a list format.


[ Rooms’ Typology (standard, superior, sea view, etc) ]


{{var:InitialRooms:""}} The number of room first requested as part of the Provider Booking
{{var:RoomChangeMsg:""}}

{{var:L3Pax:""}} A Count of the total PAX/'Clients' on this 'Departure'
{{var:L3PaxList:""}} A list of Names for this L3
{{var:L3GroupType :""}}
family, singles
{{var:ProviderType:""}} Your Labels for these: Eg: Accommodation, Activity, Transport, Meals, Other. PT1, PT2, PT3, PT4, PT5.
{{var:ProviderProduct:""}}

MergeTag: ProviderProduct = L3 level Product selected for the whole Tour


We do NOT have a Mergetag for the ACTUAL L4 Provider Products selected, as that’s only shown on the Rooming List PDF, they can send as an attachment. Seems we do NOT offer a MergeTag of ACTUAL rooms…


{{var:Meal:""}} Provider Meal Product
{{var:L5DietaryList:""}} A list of Names and their dietary requirements for this L3
{{var:SpecificProductsSharing:""}}

For including the Specific Rooming Products  and sharing selections selected by each customer, as shown on the RoomingSummaries tab


Added 26 March 2025,  tested successfully

Accomm Product - Al Pacino, Tanya Turner

Accomm Product - Billy Bob

Accomm Product - Callum Barker

Accomm Product - Jack Underwood, Tom Fernley

Accomm Product - Mandy Barker, Andy Barker

Accomm Product - William Barnes

User uploaded image

{{var:GenericProductsSharing:""}}

For including the Generic Rooming Products and sharing selections of each customer, as shown on the RoomingSummaries tab


Added 26 March 2025, tested successfull

Double - Ensuite - Al Pacino, Tanya Turner

Double - Ensuite - Jack Underwood, Tom Fernley

Double - Ensuite - Mandy Barker, Andy Barker

Double - Ensuite - William Barnes

Single - Billy Bob

Single - Callum Barker

User uploaded image

{{var:RoomsRequired:""}}

For including the customer name with the generic room type they require.  (no sharing is shown)


Added 26 March 2025, tested successfully

Mandy Barker [ Double - Ensuite ]

Andy Barker [ Double - Ensuite ]

Callum Barker [ Single ]

Tanya Turner [ Double - Ensuite ]

Al Pacino [ Double - Ensuite ]

Billy Bob [ Single ]

Tom Fernley [ Double - Ensuite ]

Jack Underwood [ Double - Ensuite ]

William Barnes [ Double - Ensuite ]

User uploaded image

{{var:L3PCountPax:""}}

Holds values regardless of the type of Provider, eg: How many pax are on a Helicopter ride, or Mapua Ferry, as well as how many are staying at a certain Accomodation.


 Added April 2025, tested. 


{{var:ListNameProductMeal""}}

had been created and will display results like this:



It is purely the Name of the Client, their Room Type of Selected Room (not Generic), & their chosen Meal... (not the general meal..this is the meal assigned to THEM)


Please note this does NOT include details of who are sharing rooms.


 Added April 2025, not yet tested 


Caro Wise : Twin Beds - Ensuite - Breakfast

Gerry Willis : Twin Beds - Ensuite - Breakfast

Glenn Castle : Twin Beds - Ensuite - Breakfast

Penny Castle : Twin Beds - Ensuite - Breakfast

Sharyn Willis : Twin Beds - Ensuite - Breakfast

Willy Roxburgh : Twin Beds - Ensuite - Breakfast



Subject

Subject

This is NOT a specific Merge tag, but a combination of 1 merge tag & 2 fields from Odyssey.


L3Code + MailJet Template Short Description + Company Name,  Which might look like: [ CSATM3 - Balance payment required - Bill's Cycle Tours ]




URL's for use on BUTTONS


URLs (website addresses ) when used as the link on a button, eg: [ Update your info ] which then takes the user to a separate website, need to be handled slightly differently.  They will be entered on the button url path as eg: {{data:urlformagree}}  Note: it must be entered exactly.  

Please refer to the MailJet template configuration page for specific details.

{{var:L3URL1:""}} URL field 1, Product Details This is full URL path used on Departure | Email | Service Content | URLs field. By entering a URL in this location on the Departure, you are able to include Departure specific URL's, for example to the cancellation policy for this trip,
{{var:L3URL2:""}} URL field 2, Product Downloadable The full URL path for extra content.  This can be useful to provide eg: a link for Downloadable content , such as a .pdf brochure on this scheduled departure or trip,
{{var:L3URL3:""}} URL field 3, Ride with GPS The full URL path for extra content.  This can be useful to provide eg: a link for Downloadable content
{{var:L3URL4:""}} URL field 4, Survey
{{var:L3URL5:""}} URL field 5, Photo Sharing Designed to show the full URL path of a departure specific link to a photo gallery for your clients to upload photos of their adventure to share with other clients.
{{var:L3URL6:""}} URL field 6, WhatsApp - Social Media
{{var:L3URL :""}} URL field 7, Meal Link



When the Advance module of online forms is being used, these following merge tags will provide URL links to a 'Client's' personalised online form. It will be pre-populated with any existing related data held in Odyssey for that 'Client'.

{{var:urlformpersonal:""}} Various 'Client' details eg: Address, Diet
{{var:urlformagree:""}} Agreement form with online Signature ability
{{var:urlformprovider:""}}
{{var:firstname:""}} For use on a button label, to identify whose Cognito Form will be viewed