How do I create an unsubscribe form?

You can create your own unsubscribe form by which your contacts can unsubscribe. This is extremely interesting if you want to maintain subsciptions to different contact groups separately. A contact can then unsubscribe from one contact group without unsubscribing from another.

We distinguish two ways of unsubscribing from specific contact groups, depending on whether you want the contact to unsubscribe from a static or a dynamic  contact group.

You create this unsubscribe form on a landing page, and you insert a link to this landing page on all your e-mails.

Note: On the Addemar basic templates, the link to the unsubscribe page is uneditable. Contact the Addemarteam if you want the unsubscribe link on a basic template to refer to your own unsubscribe form.


To create an unsubscribe form by which a contact can unsubscribe from a specific static contact group:


  1. Create a form with a simple <form> tag. Name and action are not required, just take method="post". An example:

    <form action="" name="" method="post" ></form>

  2. Insert a text field with name="email" andvalue="<?email?>". The e-mail address will appear on the unsubscribe form.

  3. Include the following hidden fields:

    • Contact group ID

      <input type="hidden" name="id" value="">

      Insert the id's of the contact group(s) from which you want to unsubscribe via this form as a value, separated by comma's. E.g. value="182,176,84".

      If you leave the value empty, the contact will be unsubscribed generally, and be added to the unsubscribers list. If you fill in the contact group id’s, the contact will not be added to the unsubscribers list, only unsubscribed from the contact group(s) mentioned.

      Note: you find the contact group ID by clicking the  icon next to the contact group. The URL in your browser contains a "gid" now. The number behind this gid is the contact group ID. (e.g. 182 in case gid=182)

    • Source

      <input type="hidden" name="source" value="">

      Insert the source you want to mention with all unsubscribed contacts as a value, e.g. "unsubscribe form". This source will be visible in the history of every contact that changed his subscription to a contact group via this form.

    • Type of unsubscription

      <input type="hidden" name="type" value="0">

      Insert the type of unsubscribe scenario you want. You can set the value to:

      • 0: simple opt-out. No e-mail will be sent. Only the confirmation page you set in "ret" will be shown.

      • 1: confirmed opt-out. The subscriber will receive a message confirming he has unsubscribed.

      When you choose option 1, a standard confirmed opt-in and double opt-in message are send in your own house style. You should also specify the language of this message (see below).

    • Language

      <input type="hidden" name="lan" value="nl_BE">

      Insert the language you want for the opt-out messages. You can set the value to:

      • nl_BE (Dutch)

      • fr_BE (French)

      • en_UK (English)


    • Return address

      <input type="hidden" name="ret" value="">

      Insert an address to return to as value. When the unsubscriber has clicked the unsubscribe button, he should receive some kind of confirmation. You can:

      • show him the standard message ("you have been unsubscribed from ??????"). Leave the value blank.

      • redirect him to a company webpage. Fill in the URL as value (ex. http//


    • Status code

      <input type="hidden" name="status" value="">

      If you redirect the unsubscribed contact to a URL, you can add a status code to this URL as a parameter.

      • Set the value to 0, no status code will be added to the URL.

      • Set the value to 1, the following status codes will be added to the URL: 0: ok, 1: format error, 2: contact not found, 3: contact already unsubscribed

  4. Insert a button with name="action_unsubscribe".

    An example:

    <input type="submit" name="action_subscribe" value="subscribe">