The BigMailer Developer Hub

Welcome to the BigMailer developer hub. You'll find comprehensive guides and documentation to help you start working with BigMailer as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Built In Merge Tags

Variables

The merge tag variables available to use in a campaign depend on the fields you have created in the brand. However, there are some merge tag variables that are always available.

Tag

Description

*|CAMPAIGN:ID|*

ID of the campaign.

*|_ID|*

ID of the contact.

*|UNSUB|*

URL to the contact's unsubscribe page.

*|VIEW|*

URL to view the camapaign in the browser. ("View in Browser" link)

If

Using the if merge tag you can make the content of your campaigns conditional on the attributes of the contact. The ELSE section is optional.

*|IF:STATUS = 'paid'|*
    <p>Thank you for subscribing!</p>
*|ELSE:|*
    <p><a href="#">Subscribe now and receive 10% off</a></p>
*|END:IF|*

The if merge tag can also include 1 or more ELSEIF sections:

*|IF:STATUS = 'paid'|*
    <p>Thank you for subscribing!</p>
*|ELSEIF:STATUS = 'cancelled'|*
    <p><a href="#">We want you back! Join now and receive 10% off</a></p>
*|ELSE:|*
    <p><a href="#">Subscribe now and receive 10% off</a></p>
*|END:IF|*

Operators

The following operators may be used with the if merge tag:

Operator

Description

=

Equal
*|IF:STATUS = 'paid'|*

!=

Not Equal
*|IF:STATUS != 'paid'|*

gt

Greater than
*|IF:AGE gt 30|*

lt

Less than
*|IF:AGE lt 30|*

gte

Greater than or equal
*|IF:AGE gte 30|*

lte

Less than or equal
*|IF:AGE lte 30|*

Functions

Default

Use the DEFAULT function to provide a default value for a variable when it is not defined or has an empty value.

Example

Description

*|DEFAULT:FIRST_NAME, 'Friend'|*

When contact has a first name available, output their first name. Otherwise, output the word friend.

Date Format

Use the DATE_FORMAT function to format a date/time into the desired format.

Example

Description

*|DATE_FORMAT:'%Y'|*

Output the current four digit year ex. 2020

*|DATE_FORMAT:'%Y-%m-%d'|*

Output the current year, month, and day ex. 2020-11-10

*|DATE_FORMAT:'%Y-%m-%d',RSSITEM:PUB_DATE|*

Output the year, month, and day of the current RSS item published date

Format codes

CodeDescriptionExample
%BLong monthJanuary
%bShort monthJan
%mMonth number01
%ALong week dayMonday
%aShort week dayMon
%dDay of month02
%HHour (24 hr clock)15
%IHour (12 hr clock)03
%MMinutes04
%SSeconds05
%YLong year2006
%yShort year06
%pAM/PMPM
%ZTimezoneMST
%zNumeric Timezone-0700

Safe

Use the SAFE function to indicate that a variable should be output as HTML. Safe is helpful when you have a variable containing HTML that needs to be output as is, without any escaping.

Example

Description

*|SAFE:MY_HTML|*

Outputs the value of the variable MY_HTML without HTML escaping.

Url

Use the URL function to urlencode a variable.

Example

Description

*|URL:FIRST_NAME|*

Outputs the value of FIRST_NAME url encoded.

Updated 15 days ago

Built In Merge Tags


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.