Form Structure

Last Updated: 15/2/2024     Tags: unsubscribe, form structure
  • Switch Version
  • V5
  • V4

The structure of the unsubscribe form is described below. The action attribute of the form must be http[s]://<client>.taguchimail.com/u/, where <client> is the Taguchi server name (contact Taguchi Support if unknown); the method attribute must always be POST, but the name attribute may be any suitable name.

<form name="unsub" action="http://<client>.taguchimail.com/u/" method="post">
    ...
</form>

Destination Page

The value of the dest input specifies the page URL to which the client should be redirected on successful submission of the form. If blank, form submission will return an event token which can be used to link subsequent events to the submission.

<input type="hidden" name="dest" value="" />

Error Page

The value of the err input specifies the page URL to which the client should be redirected if form submission fails. If blank, a failed form submission will redirect the client back to the origin page (as supplied by the user-agent in the Referer [sic] header).

<input type="hidden" name="err" value="" />

Organization ID

The organization_id input specifies that the form manages unsubscribe requests for a specific organization; this must be set to the numeric ID of the appropriate organization as shown in the Taguchi admin interface.

<input type="hidden" name="organization_id" value="" />
Email

The email input determines which subscriber is unsubscribed.

<input type="text" name="email" value="" />

Subscriber List

If the list input is present and set to the numeric ID of a list as shown in the Taguchi admin interface, the subscriber will be unsubscribed from that list only. Otherwise, the subscriber will be marked as globally unsubscribed.

<input type="hidden" name="list" value="1" />

Custom Data

Custom event data may be saved using inputs named annotation_<fieldname>; an event field named <fieldname> will be added to the database with the specified value. Custom event data are linked to the logged unsubscribe event, and are saved as UTF-8 encoded text with no maximum length.

<input type="text" name="annotation_FIELDNAME" value="" />