HomeTutorialsAPI Reference
Tutorials

Unsubscribe Links in Email

Suggest Edits

Email Unsubscribe Link

OptiPub's Unsubscribe Link URL is made using the base opt-outs URL with a submailinghash token macro, and the op-notrack parameter.


https://[client].app.optipub.com/messages/opt-outs/{$submailinghash}?op-notrack


At send time, the {$submailinghash} macro expands into a 64 character token created from the email recipient's Subscriber ID and the Mailing ID of the message or auto responder.

The Unsubscribe Link hosts a webpage with an unsubscribe form that must be submitted to perform the Unsubscribe Action.

During the Unsubscribe Action, OptiPub decodes the submailinghash, and matches the Subscriber ID to an email address and the Mailing ID to the message's Publication, and ends matching Subscriptions for that Publication.


🚧

Unsubscribe Link Limitation

The Unsubscribe Link works to end subscriptions only on the publication that sent the message.

If you send a message to multiple publications, the Unsubscribe Link will only end subscriptions for the publication configured on the message.


Email Unsubscribe Macro


📘

{$sys_email_unsubscribe}

Use the {$sys_email_unsubscribe} macro in Templates to add an unsubscribe link URL to Messages and Auto Responders.

The macro expands to the Unsubscribe Link URL during message creation


This macro is the exact same thing as the Unsubscribe Link URL, so it's just a URL, not a complete link element. Use the macro for the value of href or URL in a link element.


Removal actions using the Unsubscribe Link

Adding certain URL parameters to the Unsubscribe Link can cause the Unsubscribe Action to modify the subscription, but when these parameters are used, the action cannot end the subscription.


Remove Subscription Tags

The URL parameter tag_ids=[x] will make the Unsubscribe Action remove Subscription Tags from the Subscription instead of ending the Subscription.

{$sys_email_unsubscribe}&tag_ids=[12]
{$sys_email_unsubscribe}&tag_ids=[12,20]
https://[client].app.optipub.com/messages/opt-outs/{$submailinghash}?op-notrack&tag_ids=[12]

{$sys_email_unsubscribe}&tag_ids=[12]
{$sys_email_unsubscribe}&tag_ids=[12,20]
https://[client].app.optipub.com/messages/opt-outs/{$submailinghash}?op-notrack&tag_ids=[12]

Remove Email from Segment

The URL parameter segment_ids=[x] will cause the Unsubscribe Action to remove the email address from the specified Segment IDs in the parameter value. But it will not end the Subscription.

{$sys_email_unsubscribe}&segment_ids=[1234]
{$sys_email_unsubscribe}&segment_ids=[1234,2345]
https://[client].app.optipub.com/messages/opt-outs/{$submailinghash}?op-notrack&segment_ids=[1234,2345]

{$sys_email_unsubscribe}&segment_ids=[1234]
{$sys_email_unsubscribe}&segment_ids=[1234,2345]
https://[client].app.optipub.com/messages/opt-outs/{$submailinghash}?op-notrack&segment_ids=[1234,2345]

How to Add the Unsubscribe Link


Click Tracking Ignores Unsubscribe Links

The op-notrack parameter serves an important purpose, it prevents the unsubscribe link from getting converted into a click tracking link. This means unsubscribe link clicks are not tracked.

The op-notrack parameter can be added to any email link to prevent tracking.

Untracked link clicks:

  • do not trigger funnels.
  • are not matched in funnel or dynamic segment query conditions.
  • are not considered for engagement
  • are not included in click totals

Updated about 4 hours ago