Visit our new support portal at support.envoke.com





Skip to end of metadata
Go to start of metadata

Merge, or dynamic, fields are replaced with data from the contact record of the recipient in emails you send from Envoke. You can add merge fields anywhere in the body of an email message, landing page or event and also in email subject lines.

Basic contact merge fields

 Basic merge fields

{email}, {fname}, {lname}, {company}, {phone}, {phone2}, {cell}, {fax}, {province}, {country}, {city}, {postal}, {title}, {addr1}, {addr2}

Defaults

 Default merge fields

On the account settings page there is a field where you can enter default "first name" value to be used if a contact doesn't have a first name field in the database. The default fallback value is "Friend".

Subscriptions

 Subscriptions merge fields
{@subscriptions-all}
{@subscriptions-all|multiple}
{@subscriptions-all|checkboxes}

{@subscriptions-all|lang:en}
{@subscriptions-all|multiple|lang:en}
{@subscriptions-all|checkboxes|lang:en}


Subscription groups

  • Merge field: {@subscription-group-##} or {@subscription-group-##|select}
    • This will display a select list of the subscriptions in that group
    • can add "class" or "lang" parameter
      • {@subscription-group-##|class:class_name|lang:en}
  • Merge field: {@subscription-group-##|checkboxes}
    • This will display a list of the checkboxes of subscriptions in that group
    • can add "class", "lang" or "label" parameters
      • {@subscription-group-##|checkboxes|class:class_name|label:none}
      • {@subscription-group-##|checkboxes|class:class_name|lang:fr}


Subscription

  • Merge field: {@subscription-##} or {@subscription-##|name}
    • This will display the name of the subscription
  • Merge field: {@subscription-##|description}
    • This will display the descripton of the subscription (french or english depending on the contact)
    • can add "lang" parameter
      • {@subscription-##|description|lang:fr}
  • Merge field: {@subscription-##|hidden}
    • This will display a hidden input element for the subscription
  • Merge field: {@subscription-##|checkbox}
    • This will display a checkbox input element for the subscription
    • can add "class" , "lang" or "label" parameters
      • {@subscription-##|class:class_name|label:none}
      • {@subscription-##|class:class_name|lang:en}


Consent

  • Merge field: {@consent-field} or {@consent-field|checkbox}
    • This will display the consent checkbox with label
    • can add "class" or "lang" or "label" parameter
      • {@consent-field|class:class_name|label:none}
      • {@consent-field|class:class_name|lang:fr}
  • Merge field: {@consent-field|hidden}
    • This will display a hidden input element for the consent field
  • Merge field: {@consent-label}
    • This will display the consent message
    • can add "class" or "lang" parameter
      • {@consent-label|class:class_name|lang:en}


Custom

  • This is only setup for cid=1 within the client config collection (privacy)
  • Merge field: {@custom-privacy} or {@custom-privacy|text}
    • output custom merge field as text only
  • Merge field: {@custom-privacy|html}
    • output custom merge field as html

Custom fields

 Custom field merge fields

{@my-FIELDNAME}

Example: If your custom field is called "classID", then the merge field to use is: {@my-classID}

Additional merge fields

 Additional merge fields

Message

  • URL (view online link): {@msg-url}
  • name: {@msg-name}
  • ID: {@msg-id}
  • URL (text only): {@msg-txturl}
  • Subject line: {@msg-subject}
  • Link to Consent and Subscription Preferences page: {@pref-1}
  • Link to one-click unsubscribe: {@pref-1}/2
  • Link to French language Consent and Subscription Preferences page: {@pref-1}/fr
  • Contact ID - assigned by system: {id}
  • Consent banner: {@consent-banner}

Form

  • Interest group: {@ig-id|select}
    •  Example: If the group/folder has "id=12345", then the merge field to use is: {@ig-12345|select}

Dates

  • Current year:  {@sys-timestamp|Y}
  • Date formatted: {@sys-timestamp|Y-m-d}
  • Next year:  {@sys-timestamp|Y|1y}
  • Today plus 6 months, 2 weeks and 3 days: {@sys-timestamp|Y-m-d|6m2w3d}
    • Time increments:
      • s = second
      • i = minute
      • h = hour
      • d = day
      • w = week
      • m = month
      • y = year
    • Time formats:
      • d - The day of the month (from 01 to 31)
      • j - The day of the month without leading zeros (1 to 31)
      • l (lowercase 'L') - A full textual representation of a day
      • F - A full textual representation of a month (January through December)
      • m - A numeric representation of a month (from 01 to 12)
      • M - A short textual representation of a month (three letters)
      • n - A numeric representation of a month, without leading zeros (1 to 12)
      • Y - A four digit representation of a year
      • y - A two digit representation of a year
      • a - Lowercase am or pm
      • g - 12-hour format of an hour (1 to 12)
      • h - 12-hour format of an hour (01 to 12)
      • i - Minutes with leading zeros (00 to 59)
      • s - Seconds, with leading zeros (00 to 59)
      • T - Timezone abbreviations (Examples: EST, MDT)
      • Full list: http://www.w3schools.com/php/func_date_date.asp

Social

  • Facebook url: {@social-facebook|url}
  • Twitter url: {@social-twitter|url}
  • LinkedIn url: {@social-linkedin|url}
  • Google+ url: {@social-googleplus|url}
  • Instagram url: {@social-instagram|url}
  • Pinterest url: {@social-pinterest|url}
  • YouTube url: {@social-youtube|url}
  • Vimeo url: {@social-vimeo|url}
  • RSS url: {@social-rss|url}
  • TripAdvisor url: {@social-tripadvisor|url}

Branding

  • Use this merge field in emails or landing pages: {@brand-(header|footer|logo|company|color1)}

    • Example: Use {@brand-logo} to show logo, which is set on "Account Settings" page

 

Brochures

 Brochure merge fields

Specific brochure content merge fields

Replace id with brochure id

{@brochure-id|name}

{@brochure-id|description}

{@brochure-id|image}

{@brochure-id|checkbox}

{@brochure-id|hidden}

{@brochure-group-id|select}


Example: If the brochure has "id=12345", then the merge field to use is: {@brochure-12345|name}

Downloads

 Download merge fields

Specific download content merge fields

Replace id with download id

{@download-id|name}

{@download-id|description}

{@download-id|image}

{@download-id|checkbox} - label:name , label:description, and label:none

{@download-id|hidden}

{@download-group-id|select}




Example: If the download has "id=12345", then the merge field to use is: {@download-12345|name}

Events

 Event merge fields

{@event|name}

{@event|content}

{@event|start_date}

{@event|end_date}

{@event|start_time}

{@event|end_time}

{@notification-content}

{@brand-logo}


Example: If the event has "id=12345", then the merge field to use is: {@event-12345|name}

 

Specific event content merge fields

Replace id with event id

{@event-id|name}

{@event-id|content}

{@event-id|start_date}

{@event-id|end_date}

{@event-id|start_time}

{@event-id|end_time}

 

Specific event form elements merge fields

Replace id with event id

{@event-id|hidden}

{@event-id|checkbox}

 

Event groups on forms: (select dropdown field)

Replace id with event group id

{@event-group-id|select}

{@event-group-id|select|no_name— event name is NOT displayed, use with other parameters only such as start_date|start_time otherwise a blank selector is shown

{@event-group-id|select|start_date}

{@event-group-id|select|start_date|start_time}

{@event-group-id|select|start_date|start_time|end_time}



Date and time formats usage

replace 'start_date' in above merge fields with 'start_date:FORMAT'

examples:

'start_date:long_date'

'start_time:full_time'

merge field example:

{@event-group-id|select|start_date:short_date|start_time:short_time|end_time:full_time}

 

Date formats for: start_date and end_date

short_date = Jul 06, 2015

short_full_date = Mon Jul 06 2015

long_date = July 6th, 2015

long_full_date = Monday July 6th, 2015

numeric_date = 2015-07-06

euro_numeric_date = 06/07/2015

ISO8601 Formatting

"iso8601_date" = 2015-07-06
"iso8601_basic_date" = 20150706

"iso8601_time" = 15:30:18
"iso8601_time_tz" = 15:30:18+04:00
"iso8601_basic_time" = 153018
"iso8601_basic_time_tz" = 153018+0400
"iso8601_basic_time_utc" = 203018Z

"iso8601_datetime" = 2015-07-06T15:30:18
"iso8601_datetime_tz" = 2015-07-06T15:30:18+04:00
"iso8601_basic_datetime" = 20150706T153018
"iso8601_basic_datetime_tz" = 20150706T153018+0400
"iso8601_basic_datetime_utc" = 20150706T203018Z

Example
Add to calendar: <a href="{@event|calendar_url}" style="color: rgb(0, 0, 238);">Outlook</a> | <a href="https://www.google.com/calendar/render?action=TEMPLATE&text={@event|name}&dates={@event|start_date:iso8601_basic_datetime_utc}/{@event|end_date:iso8601_basic_datetime_utc}" style="color: rgb(0, 0, 238);">Google</a> | <a href="{@event|calendar_url}" style="color: rgb(0, 0, 238);">Other calendars</a>

 

 

Times formats for: start_time and end_time

short_time = 3:30

full_time = 3:30 pm

24h_time = 15:30

timestamp = 2015-07-06 15:30:18


Event guests

HTML input field names for guests inputs: (replace ## with id)

offer_respondent_details[##][guests]
offer_respondent_details[_all][guests] 

Example input:
<input name="offer_respondent_details[_all][guests]" value="">

Example select:
<select id="guests" name="offer_respondent_details[_all][guests]">
	<option value="0" selected="selected" disabled="disabled">0</option>
	<option value="1">1</option>
	<option value="2">2</option>
	<option value="3">3</option>
	<option value="4">4</option>
	<option value="5">5</option>
	<option value="6">6</option>
	<option value="7">7</option>
	<option value="8">8</option>
	<option value="9">9</option>
	<option value="10">10</option>
</select>

Webinars

 Webinar merge fields

{@webinar-id|name}

{@webinar-id|start_time:full_time_tz}, {@webinar-id|start_date}

{@webinar-id|end_time:full_time_tz}, {@webinar-id|end_date}

{@webinar-id|description}

{@webinar-id|hidden}


Date formats are the same as for Events (see above)


Message

Example: If the webinar has "id=12345", then the merge fields to use in message are:

{@webinar-12345|name}

 Start - {@webinar-12345|start_time:full_time_tz}, {@webinar-12345|start_date}

End - {@webinar-12345|end_time:full_time_tz}, {@webinar-12345|end_date}

 {@webinar-12345|description}


Registration message

{@webinar|start_date}

{@webinar|name} 

{@webinar|description}

{@webinar|join_url}

 

Form

Example: If the webinar has "id=12345", then the merge field to use on form is: {@webinar-12345|hidden}

Sales Users

 Sales Users merge fields

Add currently assigned salesperson details to emails (transactional or marketing) sent to leads.

{@user-sales|signature}
{@user-sales|photo}
{@user-sales|phone}

Alternatively you can merge fields from a specific user by user ID:

{@user-1038|signature}
{@user-1038|photo}
{@user-1038|phone}

In order to edit these fields you must have a "developer" user type.