Supported personalization tags

This reference article covers a complete list of supported Liquid personalization tags.

Summary of supported tags

As a convenience, a summary of supported personalization tags are provided. For more detail on each type of tag and best practices, continue reading.

Supported attributes

Campaign, Card, and Canvas attributes are only supported in their corresponding messaging templates (for example, dispatch_id isn’t available in in-app message campaigns).

Refer to this help article to learn more about how some of these attributes differ across sources in Braze.

Canvas and campaign tag differences

The behavior for the following tags differs between Canvas and campaigns:

• dispatch_id behavior differs because Braze treats Canvas steps as triggered events, even when they are “scheduled” (except for entry steps, which can be scheduled). To learn more, refer to Dispatch ID behavior.
• Using the {{campaign.${name}}} tag with Canvas will display the Canvas component name. When using this tag with campaigns, it will display the campaign name.

Most recently used device information

You can template the following attributes for the user’s most recent device across all platforms. If a user has not used your application (for example, you imported the user via REST API), then these values will all be null.

Because there is such a wide range of device carriers, model names, and operating systems, we advise that you thoroughly test any Liquid that conditionally depends on any of those values. These values will be null if they are not available on a particular device.

Targeted app information

For in-app messages, you can use the following app attributes within Liquid. The values are based on which SDK API key your apps use to request messaging.

For example, this Liquid code will abort a message if the requesting apps are not one of the two API keys in the list:

1
2
3
4
5
6
{% assign allowed_api_keys = 'sdk_api_key_1,sdk_api_key_2' | split: ',' %}
{% if allowed_api_keys contains {{app.${api_id}}} %}
User is in list of apps
{% else %}
{% abort_message("User not in list of apps") %}
{% endif %}

Targeted device information

For push notifications and in-app message channels, you can template in the following attributes for the device to which a message is being sent. That is, a push notification or in-app message can include device attributes of the device on which the message is being read. Note that these attributes won’t work for Content Cards.

Because there is such a wide range of device carriers, model names, and operating systems, we advise that you thoroughly test any logic that conditionally depends on any of those values. These values will be null if they are not available on a particular device.

Furthermore, for push notifications, it’s possible that Braze won’t be able to discern the device attached to the push notification under certain circumstances such as if the push token was imported through API, resulting in values being null for those messages.

Using conditional logic instead of a default value

In some circumstances, you may opt to use conditional logic instead of setting a default value. Conditional logic allows you to send messages that differ based on the value of a custom attribute. Additionally, you can use conditional logic to abort messages to customers with null or blank attribute values.

Use case

For example, let’s say you’re sending a rewards balance notification to customers. There isn’t a good way to account for customers with low and null balances using default values.

In this case, there are two options that may work better than setting a default value:

1. Abort the message for customers with low, null, and blank balances.

   1
   2
   3
   4
   5
   {% if {{custom_attribute.${balance}}} > 0 %}
   Your rewards balance is {{custom_attribute.${balance}}}
   {% else %}
   {% abort_message() %}
   {% endif %}
   

2. Send a completely different message to these customers, such as:

   1
   2
   3
   4
   5
   {% if ${first_name} != blank and ${first_name} != null %}
   Hello {{${first_name} | default: 'there'}}, thanks for downloading!
   {% else %}
   Thanks for downloading!
   {% endif %}
   

In this use case, a user with a blank or null first name will get the message “Thanks for downloading”. You should include a default value for first name to make sure that your customer doesn’t see Liquid in the event of a mistake.

Variable tags

You can use the assign tag to create a variable in the message composer. We recommend using a unique name for your variable. If you create a variable with a similar name to the supported personalization tags (such as language), this may affect your messaging logic.

After you create a variable, you can reference that variable in your messaging logic or message. This tag comes in handy when you want to reformat content that is returned from our Connected Content feature. You can read more in Shopify’s documentation on variable tags.

Use case

Let’s say that you allow your customers to cash in their rewards points for prizes after they accrue 100 rewards points. So, you only want to message customers who would have a points balance greater than or equal to 100 if they made that additional purchase:

1
2
3
4
5
6
{% assign new_points_balance = {{custom_attribute.${current_rewards_balance} | plus: 50}} %}
{% if new_points_balance >= 100 %}
Make a purchase to bring your rewards points to {{new_points_balance}} and cash in today!
{% else %}
{% abort_message('not enough points') %}
{% endif %}

Iteration tags

Iteration tags can be used to run a block of code repeatedly. The use case below features the for tag.

Use case

Let’s say that you’re having a sale on Nike sneakers and want to message customers who’ve expressed interest in Nike. You have an array of product brands viewed on each customer’s profile. This array could contain up to 25 product brands, but you only want to message customers who viewed a Nike product as one of their 5 most recent product views.

1
2
3
4
5
6
7
8
9
10
{% for items in {{custom_attribute.${Brands Viewed}}} limit:5 %}
{% if {{items}} contains 'Converse' %}
{% assign converse_viewer = true %}
{% endif %}
{% endfor %}
{% if converse_viewer == true %}
Sale on Converse!
{% else %}
{% abort_message() %}
{% endif %}

In this use case, we check the first five items in the sneaker brands viewed array. If one of those items is converse, we create the converse_viewer variable and set it to true.

Then, we send the sale message when converse_viewer is true. Otherwise, we abort the message.

This is a simple example of how iteration tags can be used in the Braze message composer. You can find more information in Shopify’s documentation on iteration tags.

Syntax tags

Syntax tags can be used to control how Liquid is rendered. You can use the echo tag to return an expression. This is the same as wrapping an expression using curly brackets, except you can use this tag within Liquid tags. You can also use the liquid tag to have a block of Liquid without any delimiters on each tag. Each tag has to be in its own line when using the liquid tag. Check out Shopify’s documentation on syntax tags for more information and examples.

With whitespace control, you can remove whitespaces around your tags, helping you further control what the Liquid output looks like.

HTTP status codes

You can utilize the HTTP status from a Connected Content call by first saving it as a local variable and then using the __http_status_code__ key. For example:

1
2
3
4
{% connected_content https://example.com/api/endpoint :save connected %}
{% if connected.__http_status_code__ != 200 %}
{% abort_message('Connected Content returned a non-200 status code') %}
{% endif %}

Sending messages based on language, most recent locale, and time zone

In some situations, you may wish to send messages that are specific to particular locales. For example, Brazilian Portuguese is typically different than European Portuguese.

Use case: Localize based on recent locale

Here’s a use case of how you can use the most recent locale to further localize an internationalized message.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{% if ${language} == 'en' %}
Message in English
{% elsif  ${language} == 'fr' %}
Message in French
{% elsif  ${language} == 'ja' %}
Message in Japanese
{% elsif  ${language} == 'ko' %}
Message in Korean
{% elsif  ${language} == 'ru' %}
Message in Russian
{% elsif ${most_recent_locale} == 'pt_BR' %}
Message in Brazilian Portuguese
{% elsif ${most_recent_locale} == 'pt_PT' %}
Message in European Portuguese
{% elsif  ${language} == 'pt' %}
Message in default Portuguese
{% else %}
Message in default language
{% endif %}

In this use case, customers with a most recent locale of pt_BR will get a message in Brazilian Portuguese, and customers with a most recent locale of pt_PT will get a message in European Portuguese. Customers who don’t meet the first two conditions but have their language set to Portuguese will get a message in whatever you’d like the default Portuguese language type to be.

Use case: Target users by time zone

You can also target users by their time zone. For example, send one message if they are based in EST and another if they are PST. To do this, save the current time in UTC, and compare an if/else statement with the user’s current time to send the right message for the right time zone. You should set the campaign to send in the user’s local time zone, to give them the campaign at the right time.

See the following use case for how to write a message that will go out between 2 pm and 3 pm and will have a specific message for each time zone.

1
2
3
4
5
6
7
8
{% assign hour_in_utc = 'now' | date: '%H' | plus:0 %}
{% if hour_in_utc >= 19 && hour_in_utc < 20 %}
It is between 2:00:00 pm and 2:59:59 pm ET!
{% elsif hour_in_utc >= 22 && hour_in_utc < 23 %}
It is between 2:00:00 pm and 2:59:59 pm PT!
{% else %}
{% abort_message %}
{% endif %}