Skip to content

Supported personalization tags

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

Personalization Tag Type Tags
Default Attributes {{${city}}}
{{${country}}}
{{${date_of_birth}}}
{{${email_address}}}
{{${first_name}}}
{{${gender}}}
{{${language}}}
{{${last_name}}}
{{${last_used_app_date}}}
{{${most_recent_app_version}}}
{{${most_recent_locale}}}
{{${most_recent_location}}}
{{${phone_number}}}
{{${time_zone}}}
{{${twitter_handle}}}
{{${user_id}}}
{{${braze_id}}}
{{${random_bucket_number}}}
Device Attributes {{most_recently_used_device.${carrier}}}
{{most_recently_used_device.${id}}}
{{most_recently_used_device.${idfa}}}
{{most_recently_used_device.${model}}}
{{most_recently_used_device.${os}}}
{{most_recently_used_device.${platform}}}
{{most_recently_used_device.${google_ad_id}}}
{{most_recently_used_device.${roku_ad_id}}}
{{most_recently_used_device.${windows_ad_id}}}
{{most_recently_used_device.${foreground_push_enabled}}}
Email List Attributes {{${set_user_to_unsubscribed_url}}}
{{${set_user_to_subscribed_url}}}
{{${set_user_to_opted_in_url}}}
SMS Attributes {{sms.${inbound_message_body}}}
{{sms.${inbound_media_urls}}}
Campaign Attributes {{campaign.${api_id}}}
{{campaign.${dispatch_id}}}
{{campaign.${name}}}
{{campaign.${message_name}}}
{{campaign.${message_api_id}}}
Canvas Attributes {{canvas.${name}}}
{{canvas.${api_id}}}
{{canvas.${variant_name}}}
{{canvas.${variant_api_id}}}
Canvas Step Attributes {{campaign.${api_id}}}
{{campaign.${dispatch_id}}}
{{campaign.${name}}}
{{campaign.${message_name}}}
{{campaign.${message_api_id}}}
Card Attributes {{card.${api_id}}}
{{card.${name}}}
Geofencing Events {{event_properties.${geofence_name}}}
{{event_properties.${geofence_set_name}}}
Event Properties
(These are custom to your app group.)
{{event_properties.${your_custom_event_property}}}
Custom Attributes
(These are custom to your app group.)
{{custom_attribute.${your_custom_attribute}}}

Canvas and campaign tag differences

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

  • dispatch_id differs between Canvas and campaigns 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 step name. When using this tag with campaigns, it will display the campaign name.

Most recently used device information

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

Tag Description
{{most_recently_used_device.${browser}}} The most recently used browser on the user’s device. Examples include “Chrome” and “Safari”.
{{most_recently_used_device.${id}}} This is Braze’s device identifier. On iOS, this is the Apple Identifier for Vendor (IDFV). For Android and other platforms, it is Braze’s device identifier, a randomly generated GUID.
{{most_recently_used_device.${carrier}}} The most recently used device’s telephone service carrier, if available. Examples include “Verizon” and “Orange”.
{{most_recently_used_device.${ad_tracking_enabled}}} If the device has ad tracking enabled or not. This is a boolean value (true or false).
{{most_recently_used_device.${idfa}}} For iOS devices, this value will be the Identifier for Advertising (IDFA) if your application is configured with Braze’s optional IDFA collection. For non-iOS devices, this value will be null.
{{most_recently_used_device.${google_ad_id}}} For Android devices, this value will be the Google Play Advertising Identifier if your application is configured with Braze’s optional Google Play Advertising ID collection. For non-Android devices, this value will be null.
{{most_recently_used_device.${roku_ad_id}}} For Roku devices, this value will be the Roku Advertising Identifier that is collected when your application is configured with Braze. For non-Roku devices, this value will be null.
{{most_recently_used_device.${windows_ad_id}}} For Windows devices, this value will be the Windows Advertising Identifier that is collected when your application is configured with Braze. For non-Windows devices, this value will be null.
{{most_recently_used_device.${model}}} The device’s model name, if available. Examples include “iPhone 6S” and “Nexus 6P” and “Firefox”.
{{most_recently_used_device.${os}}} The device’s operating system, if available. Examples include “iOS 9.2.1” and “Android (Lollipop)” and “Windows”.
{{most_recently_used_device.${platform}}} The device’s platform, if available. If set, the value will be one of ios, android, windows, windows8, kindle, android_china, web, or tvos.

Because there are 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 device information

For push notification 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 will not work for Content Cards.

Tag Description
{{targeted_device.${id}}} This is Braze’s device identifier. On iOS, this is the Apple Identifier for Vendor (IDFV). For Android and other platforms, it is Braze’s device identifier, a randomly generated GUID.
{{targeted_device.${carrier}}} The most recently used device’s telephone service carrier, if available. Examples include “Verizon” and “Orange”.
{{targeted_device.${idfa}}} For iOS devices, this value will be the Identifier for Advertising (IDFA) if your application is configured with Braze’s optional IDFA collection. For non-iOS devices, this value will be null.
{{targeted_device.${google_ad_id}}} For Android devices, this value will be the Google Play Advertising Identifier if your application is configured with Braze’s [optional Google Play Advertising ID collection]. For non-Android devices, this value will be null.
{{targeted_device.${roku_ad_id}}} For Roku devices, this value will be the Roku Advertising Identifier that is collected when your application is configured with Braze. For non-Roku devices, this value will be null.
{{targeted_device.${windows_ad_id}}} For Windows devices, this value will be the Windows Advertising Identifier that is collected when your application is configured with Braze. For non-Windows devices, this value will be null.
{{targeted_device.${model}}} The device’s model name, if available. Examples include “iPhone 6S” and “Nexus 6P” and “Firefox”.
{{targeted_device.${os}}} The device’s operating system, if available. Examples include “iOS 9.2.1” and “Android (Lollipop)” and “Windows”.
{{targeted_device.${platform}}} The device’s platform, if available. If set, the value will be one of ios, android, windows, windows8, kindle, android_china, web, or tvos. You can also use the most_recently_used_device personalization tag.
{{targeted_device.${foreground_push_enabled}}} This value will be true when the targeted device is enabled for foreground push, false otherwise.

Because there are 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 is possible that Braze may be unable to discern the device attached to the push notification under certain circumstances such as if the push token was imported via API, resulting in values being null for those messages.

Example of using a default value of "there" when using a first name variable in a push message.

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.

For example, if 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, perhaps something along the lines of:

    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 example, 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 ensure that your customer does not see Liquid in the event of a mistake.

Variable tags

You can use the assign tag to create a variable in the message composer. Once you create a variable, you can reference that variable in your messaging logic or message.

Let’s say that you allow your customers to cash in their rewards points for prizes once 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 %}

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.

Iteration tags

Iteration tags can be used to run a block of code repeatedly. This example features the for tag.

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 example, 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 Braze’s message composer. You can find more information in Shopify’s documentation on iteration tags.

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.

Here’s an example of how you can use 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 example, customers with a most recent locale of ‘pt_BR’ will get a message in Brazilian Portuguese, customers with a most recent locale of ‘pt_PT’ will get a message in European Portuguese and 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.

You can also target users based off of 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 ensure you’re sending the right message for the right time zone. You should set the campaign to send in the user’s local time zone, to ensure they are getting the campaign at the right time. See the following example for how to write a message that will go out between 2PM and 3PM 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:00pm and 2:59:59pm ET!
{% elsif hour_in_utc >= 22 && hour_in_utc < 23 %}
It is between 2:00:00pm and 2:59:59pm PT!
{% else %}
{% abort_message %}
{% endif %}
WAS THIS PAGE HELPFUL?
New Stuff!