HomeEngagementContentDiscoveryOther resources
Guides

Consent Page

Suggest Edits

The consent page lets your customers see all consent categories (including legitimate interests) you've set up in your project settings. Customers can unsubscribe from any category they choose. You should embed the consent page on your website because the opt-out option is crucial for maintaining valid customer consent. It also keeps your email deliverability rating high since people only get emails they want.

How it works

The consent page is an editor in Bloomreach Engagement that lets your customers manage their subscription preferences. Customers can opt out directly on your website.

To access the consent page editor:

  1. Under Settings, select Project settings.
  2. Under Campaigns, go to Privacy management > Consents.

Generate consent page links

The consent page uses a unique link for every customer. You can generate this link in 2 ways:

  1. Use Jinja: {{ consent.page }}.
  2. In campaigns, click the personalization button to get: <a href="{{ consent.page }}">Click here ...</a>

Where to find consent page links

You can find the consent page link in the personalization tabs of:

  • Add event (Node in a scenario)
  • Email
  • Experiments
  • Facebook message
  • Push notifications
  • Set property (Node in a scenario)
  • SMS
  • Tag manager
  • Weblayers

🚧

Tracking issues

If you use our consent page outside your own domain for subscribing or unsubscribing customers, no page_visit or session_start events are generated.

❗️

Test campaigns

The consent link only works in real launched campaigns. It won't work in test emails.

Customize your consent page

You can edit and customize the consent page using HTML, CSS, JavaScript, and Jinja. For example, you can display a specific customer's name.

What appears on the consent page

All categories you create in Project settings > Privacy management > Consents appear on the consent page for customers.

Multi-language support

You can create different language groups for the consent page. Language groups appear once you define your languages in the project settings.

Consent categories visible on the consent page

All categories created in the Project settings > Privacy management > Consents will be visible for the customers on the consent page.

Cache behavior and data freshness

If customers keep the consent page open in their browser for extended periods, they might submit outdated consent data. This happens because of caching.

Advanced customization

Hide specific categories

You can hide categories from the consent page using Jinja. This example hides two categories: category_to_hide_1 and category_to_hide_2.

Add this code to your HTML:

{% for category in categories %}
    {% if category.name not in ["category_to_hide_1", "category_to_hide_2"] %}
        <hr>
        <label>
            <input type="checkbox" value="grant" {% if category.valid %}checked{% endif %}
                    id="category_{{ category.id | escape }}"
                    name="category {{ category.id | escape }}">
            <span class="checkbox-title">{{ category.name | escape }}</span>
            {% if category.description %}
                <span class="checkbox-subtitle">{{ category.description | escape }}</span>
            {% endif %}
        </label>
    {% else %}
        <input type="checkbox" value="grant" {% if category.valid %}checked{% endif %}
            id="category_{{ category.id | escape }}"
            name="category {{ category.id | escape }}" hidden>
    {% endif %}
{% endfor %}

This visually hides the two consent categories. However, if customers click Unsubscribe from all, they'll also unsubscribe from hidden categories.

To prevent the Unsubscribe from all button from affecting hidden categories, add this JavaScript code::

{%- for category in categories -%}
    {% if category.name not in ["category_to_hide_1", "category_to_hide_2"] %}
        check = document.getElementById({{ ('category_' ~ category.id) | json }});
        if (!check.disabled) {
            check.checked = false;
        }
    {% endif %}
{% endfor %}

Create custom sub-categories

You can create custom sub-categories for each category using customer attributes. Use either boolean type (checkbox) or text input.

This example displays "Sales" as a sub-category on the consent page. The matching customer attribute in Bloomreach Engagement is newsletter_sales:

       <label>
	    <input type="hidden" name="property newsletter_sales">
	    <input type="checkbox" {% if customer.newsletter_sales %} checked="true" {% endif %} 
 id="newsletter_sales" name="property newsletter_sales">
	    <span class="checkbox-label">Sales</span>
	</label>

Boolean attribute rules

  • Names must start with property followed by the attribute name: name="property property_name".
  • Every checkbox input needs a hidden input element with the same name and no value attribute. Hidden inputs detect which checkboxes customers didn't check.
  • Hidden input elements must have the same name as the checkbox. In the example above, it's newsletter_sales.
  • Use Jinja to load existing values. Don't compare values to true ({% if customer.newsletter_sales == true %}). Use the format in the example above (line 3).
  • Checkboxes can't contain empty value attributes. Don't use value="".

Text attributes

Other attributes can use text inputs and don't need duplicated hidden inputs. Their names must start with property_text:

<label>
	<input type="text" name="property_text property_name" value="{{ customer.property_name }}">
	<span class="title">Property Name</span>
</label>

Changes appear on the consent page immediately after saving. They might take a few minutes to appear in Bloomreach Engagement.

📘

Note

Both techniques (boolean and text) only work if the <label> tag is inside the
<form method="POST" action="" id="form"> tag.

🚧

Changes in consent

When you update consents or sub-categories manually or through tracking, these changes don't appear immediately on the consent page when it reloads. This happens because of caching - the system stores the page for 30 minutes (TTL) before checking for updates.

Translate category names

You can create multiple language versions of the consent page. To translate category names, use additional Jinja code. This example translates "Newsletter" and "Personalization" into German.

First, set up translations. Add this code at the very beginning of your HTML:

{% set translations = [{
	'Newsletter': { 
		'name': 'Newsletter_in_German',
		'description':'German description text for the category'
	},
	'Personalisation': {
		'name': 'Personalisierung',
		'description': 'German descriprion text for the category'
	}
}]%}

Now use the translations. If you're translating all categories, find the line {% for category in categories %} and add this code below it:

{{translations[0][(category.name |escape)]['name'] }}
	{% if category.description %}
		{{ translations[0][(category.name |escape)]['description']  }}
	{% endif %}

Pass custom values to consent pages

If you add a query parameter mode to a consent page link, you can access the value from this parameter and change behavior when customers visit the consent page.

For example, if you have a specific marketing campaign and want to show or hide parts of the general consent page, append mode to the URL link:{{consent.page ~ "?mode=Special_campaign"}}.

Then use a Jinja {{mode}} in a consent page to access the URL value. You can use this value in an if condition to show or hide categories on the consent page. If no mode is in the link, the {{mode}} Jinja returns "default" as the value.

Multi-language considerations

If you're using multiple language versions of the consent page, the ?lang parameter always gets added first. Using
?mode=Special_campaign creates an invalid query string like ?lang?mode=Special_campaign when it should be ?lang&mode=Special_campaign. Use &mode=Special_campaign instead of ?mode=Special_campaign.

For customers with and without language properties, use an if-else statement to change the ? sign to & for customers with language properties: {%-if customer.language is defined -%}{{- consent.page ~ "&mode=survey" -}}{%-else -%}{{- consent.page ~ "?mode=survey" -}}{%- endif -%}\

Track consent events

Consent events tracked from consent pages can trigger Scenarios.

Updated 2 days ago