Summary / TL:DR: This article will show you how to utilize unsubscribe links inside an email template.
1 min read
In order to utilize unsubscribe links inside of an email template, you need to take care of two items.
Adding the link Algorithm
In order for unsubscribe links to work properly, you must include the Link Algorithm shared asset within your email template. This should be included after your <HTML> opening tag.
| Code Block |
|---|
<shared_asset> bsft_Link_Algo </shared_asset> |
Note: You only need to add the link algorithm once per mailing. The actual name of the Shared Asset might differ from the one represented here.
Defining an Unsubscribe Link
Within your email templates, your <a> tags need to be modified to include the unsub_link variable using liquid script.
| Code Block |
|---|
<a href="{{unsub_link}}">Unsubscribe</a> |
Important Note: You must have your unsubscribe links defined inside of the link algorithm and your base/wiki/spaces/BSSUPPORT/pages/13633203987list transaction starred in the advanced segment builder.
Putting it all together
A typical HTML email might look like the following
...
custom and relevant campaign parameters are added to all links that are sent from Blueshift.
...
Custom vid2 Parameter
In the refactored instances of Blueshift a custom parameter will be added to all triggers and therefore all links that get sent out of Blueshift will have it included by default. This parameter is the verification id. Below shows the key-value pair:
| Code Block |
|---|
key = vid2
value = {{ user_transaction.advantage_customer_number | append: '@@' | append: user_transaction.list_code | append: '@@' | append: user.email | aes256_encrypt_v2: '50655368566D597133743677397A24432646294A404E635266546A576E5A7234', '472B4B6250655368566D597133743677' }} |
Blueshift Feature Documentation
| Info |
|---|
If you would like to add additional default custom parameters please submit that request to Global Support. |
...
How it Works
The vid2 variable is comprised of the advantage customer number, list code, email address and delimiters which are then AES-256 encrypted within a single liquid object.
This variable is then decrypted by 14West systems to be used in things such as reporting, unsubscribes, and order form auto-pop.
The decrypted value will look something like the following:
000123456789@@LISTCODE@@emailadress@14west.us
Because this will be added to all links including unsubscribe links, there is no need to manually add any query parameters within the template as this will be done programmatically.
...
Blueshift Parameters
Blueshift will also automatically include link parameters relevant to the campaign itself. They are as follows:
Parameter | What is it? |
|---|---|
bsft_clkid | Unique identifier generated when clicking a link |
bsft_uid | Unique identifier assigned to the Blueshift profile |
bsft_mid | Unique message identifier* |
bsft_utid | Unique identifier assigned to the profile with the transaction list code appended to it |
bsft_mime_type | Indicates the type non-ASCII components of a message |
bsft_tv | Template version |
bsft_aaid | Unique identifier of the adapter used in the campaign |
bsft_eid | Unique identifier of experiment. Even if there is a single template on a trigger, it will generate a unique bsft_eid. |
bsft_ek | Campaign execution timestamp |
bsft_lx | Identifies the instance of the URL when the same URL is used in multiple locations in the template. |
bsft_pid | Unique ID of a Blueshift catalog item |
bsft_pp | When using an array of catalog items, this indicates the ordinal number in which the item was surfaced |
pk | This is the profile key which is comprised of the affiliate id and email address which is MD5 hashed. You can read more about this parameter here. |
vid2 | Encrypted concatenation of advantage_customer_number, list or item code, and email_address joined by ‘@@’ |
utm_campaign | Name of the campaign |
utm_source | Blueshift |
utm_medium | Channel that is used in Blueshift (Email, SMS, Push) |
The last three parameters of bsft_eid, bsft_ek, and bsft_lx are used by Data and Analytics to associate orders with a campaign and so again, there is no need to manually add any query parameters to promotion links within the template.
| Info |
|---|
Please keep in mind that these URL parameters are added automatically so there is no need to add them within the template. We have seen issues where the value is missing from the URL if any of the above parameters are added within the template. |
| Tip |
|---|
Wrap upYou should now know how |
...
Still need help?
We know this can be frustrating. To get further help please open a Support ticket.
...
the vid2 custom parameters work and what other parameters are included in Blueshift links. |
...
| Note |
|---|
Cannot find the article you’re looking for? Suggest a new article here! |
...