API Documentation

This documentation page is for a deeper level of understanding of the API parameters and usage. Please refer to our builder page to have the API automatically generated based on your needs.

Optional parameters: Should always come before calling the getEmailUnData(); method.


<div id="EmailUnDiv"></div>
<script language="JavaScript" src="https://www.b2i.us/b2i/EmailUnapi2.asp" type="text/javascript"></script>
<script language="JavaScript" type="text/javascript">
oEmailUn.BizID="2626";
oEmailUn.sKey="Sf6Ic9Gy8";
oEmailUn.sHttp="https";
getEmailUnData();
</script>

Optional parameters: Should always come before calling the getEmailUnData(); method.

Attributes Detail
oEmailUn.LabelEmail="Email"; Text to use for "Email" label
oEmailUn.LabelUnsubscribe="Email"; Label for Unsubscribe text - Default is lu="Unsubscribe from all email communications."
oEmailUn.sUnsubscribeText=""; This allows you to set a custom subscribe message that is displayed after the user clicks the subscribe button
oEmailUn.sRemoveEndPoint=""; URL to forward user to after they click unsubscribe
oEmailUn.tos="1"; Email terms of service - by default this does not show; Set to 1 to use: oEmail.tos="1";
oEmailUn.tosLabel='Your Text'; Email terms of service custom text to use
oEmailUn.tosControl="1"; Allow the terms of service to control when the Subscribe button shows.
oEmailUn.lo="2"; Email form layout - default: lo="1"; currently 1 available
oEmailUn.LangID="2"; Language to display list and text. Additional languages must be initialized. *
  Items with an * require additional configuration. Please contact us