Ctrlk
Service statusLog in
For the complete documentation index, see llms.txt. This page is also available as Markdown.

How to add an unsubscribe link to your email template?

Discover how to include an unsubscribe link in templates built with Batch's email composer or your own HTML.

Why add an unsubscribe link to your email?

Adding an unsubscribe link to your e-mail marketing campaigns allows Batch to get instant opt-out feedback and to not retarget recipients who have chosen to unsubscribe.

Thus, it allows:

  • Not to generate dissatisfaction with the recipient who has chosen not to receive e-mail marketing anymore.

  • Not to damage the sending reputation.

Unsubscribe links are mandatory in marketing campaigns, but must not be included in transactional messages.

Unsubscribe from an email is recorded when the end user clicks the unsubscribe link. The end user then lands on an unsubscribe confirmation page.

Two approaches are available depending on your setup and preference management requirements:

  • Option 1 — Native Batch unsubscribe link: Batch handles the full opt-out flow automatically.

  • Option 2 — Custom preference management page: you redirect users to your own page and update Batch programmatically.

Choosing between the two options

Option 1: Native Batch link
Option 2: Custom preference page

Implementation effort

Low

High

Opt-out granularity

Global marketing opt-out

Per newsletter or per category

Dashboard statistics

Full

Partial

Data sync to your infrastructure

Via Profiles API – Export

Built into your page

Batch opt-out statuts update

Automatic on click

Via Profiles API – Update

Confirmation page

Batch default or custom

Fully custom

Option 1: Native Batch unsubscribe link (recommended)

Adding an unsubscribe link to a template via HTML

Here is how you can simply add an unsubscribe link for an email template in a single language:

Attribute
Description

data-msys-unsubscribe="1"

Triggers the opt-out of the profile in Batch on click.

data-msys-linkname="batch::unsub"

Tags the click for campaign and automation statistics in the Batch dashboard.

If the email template already contains personalization conditions to change the language of certain text blocks, the same should be done for the unsubscribe link:

Adding an unsubscribe link to a template using the Email Composer

You can also insert an unsubscribe link easily when using the Email Composer to create your email templates.

To do so:

  1. Select the text

  2. Add a hyperlink to the text area

  3. Select the Unsubscribe option listed in the Link field on the left side panel.

{{emailComposerUnsubscribeLink()}} is only compatible with the drag-and-drop Email Composer, and should not be used for HTML email creation.

Choosing a confirmation landing page

Once recipients click the unsubscribe link:

  • Batch removes the recipients from the marketing mailing list

  • Recipients are redirected to a confirmation landing page

The purpose of the confirmation landing page is to confirm to recipients that they have been unsubscribed. When using the Email Composer unsubscribe variable, the page is automatically displayed in the end user's browser language if available, with English as a fallback. If you hardcode the URL directly in HTML, you must specify the language URL manually; there is no automatic language detection in that case.

If you want to offer recipients the option to manage their preferences or stay subscribed, host a custom landing page instead (see Option 2).

You can host your own custom landing page for full control over design and user experience, or rely on our default landing pages:

  • 🇫🇷 French: https://static.batch.com/list-management/landing.fr.html

  • 🇩🇪 German: https://static.batch.com/list-management/landing.de.html

  • 🇬🇧 English: https://static.batch.com/list-management/landing.html

  • 🇪🇸 Spanish: https://static.batch.com/list-management/landing.es.html

  • 🇮🇹 Italian: https://static.batch.com/list-management/landing.it.html

Benefits and limitations

Benefits

  • Immediate opt-out: the profile is marked as unsubscribed in Batch following the link click, preventing any further marketing sends.

  • Unsubscribe clicks are categorized as batch::unsub and visible in campaign and automation statistics.

Limitations

  • The opt-out is global for marketing emails, not per newsletter or communication type.

  • You must synchronize unsubscriptions back to your data infrastructure using the Profiles API – Export if downstream systems need to reflect opt-out status.

  • If your setup uses custom attributes to manage opt-in, those are not automatically updated: you need to handle that separately via the Profiles API – Update.

Option 2: Custom preference management page

Instead of using Batch's native, you redirect recipients to a page on your own website that handles unsubscription. Batch is updated programmatically once users confirm their choice.

Requirements

  • Build and host a preference management page that handles the unsubscribe logic.

  • Call the Profiles API – Update from your backend once users unsubscribe. To mark a profile as opted out of marketing emails, set $email_marketing to "unsubscribed" in the attributes object:

If your setup relies on custom opt-in attributes rather than the native $email_marketing field, update those attributes accordingly.

Benefits and limitations

Benefits

  • Fine-grained preference management: users can unsubscribe from specific newsletters or communication types rather than all marketing emails at once.

  • Full control over the design, copy, and user journey of the unsubscribe experience.

Limitations

  • You are responsible for building and maintaining the page and its integration with the Profiles API.

  • Unsubscribes are not categorized as batch::unsub clicks in Batch analytics, reporting is less detailed compared to Option 1.

Read more

PreviousLink & Tracking SettingsNextHow to handle link tracking in emails?

Last updated