Skip to main content

Email Service Providers (ESPs)

You may already have a large pool of identified users in your ESP. To enable ATS.js to leverage these identifiers, you will need to modify your standard newsletters or transactional emails to pass an identifier when users click through to visit your site. The process of sending emails to ATS.js consists of two parts:

  1. Modifying the link in your email campaign.

  2. Configuring envelope settings in Console.

Are you working with a provider that is not listed in this article? This method should work on most ESP's outside of the ones listed on this article as well. Contact our support team via the chat button to learn more.

Tip

Email Newsletters vs. Direct Login

It's always best to leverage direct logins from your users. This gives the best transparency into what data are being processed on their behalf and also ensures that you have the correct user identity, as emails can be forwarded to individuals other than the original recipient.

Step 1: Modify the Link in Your Email Campaign

  1. In your email campaign body, insert a new link or modify an existing one that your users will click.

  2. Add an additional query parameter (e.g. user_id) and then add a macro to represent the user's email address after the query parameter. Some ESP's such as Iterable accommodates custom parameters in their advanced settings. Refer to the table to learn which macro you should insert based on the ESP.

  3. Save your link and finish creating your email template or broadcast. When you send the email in production, the macro will be populated with the recipient's email.

The table below lists the macro you need to add to the link based on the ESP:

ESP

Macro

Example

AWeber

PP-ESPs_AWeber.png

{!email}

https://authenticated-traffic-solution.com?e={!email}

blueshift

PP-ESPs_blueshift.png

{{user.email}}

https://authenticated-traffic-solution.com?email={{user.email}}

Campaign Monitor

PP-ESPs_Campaign_Monitor.png

[email]

https://authenticated-traffic-solution.com?user_id=[email]

ConvertKit

PP-ESPs_ConvertKIt.png

{{ subscriber.email_address }}

https://authenticated-traffic-solution.com?user_id={{ subscriber.email_address }}

ExactTarget

PP-ESPs_ExactTarget.jpeg

%%emailaddr%%

%%=SHA256(LOWERCASE(TRIM(emailaddr)))=%%

Iterable

PP-ESPs_Iterable.png

Learn more about their custom link parameters here.

Klaviyo

PP-ESPs_Klaviyo.png

{{ email }} (no query parameters needed)

www.example.com/{{ email }}

mailchimp

PP-ESPs_mailchimp.png

*|EMAIL|*

https://authenticated-traffic-solution.com?user_id=*|EMAIL|*

Sailthru

PP-ESPs_Sailthru.png

  • {sha256(email)}

  • {sha1(email)}

  • {md5(email)}

  • https://authenticated-traffic-solution.com?user_email={sha256(email)}

  • https://authenticated-traffic-solution.com?user_email={sha1(email)}

  • https://authenticated-traffic-solution.com?user_email={md5(email)}

Tip

Updating Sailthru Newsletter Templates in Bulk

Currently, Sailthru does not support updating newsletter templates in bulk. As a work-around, we reccommend you call Sailthru's template API endpoint and follow the steps below.

Endpoint URL: https://api.sailthru.com/template

  1. Make a GET request to the template API endpoint with an empty request body. This will return a list of all templates in your account. Note each of the "template_id" value which is required for the next step.

  2. For each template, make a GET request to the template API endpoint with the following payload:

    {"template_id": <template_id value from previous step>}

  3. The API response will include the complete metadata for the template. Automatically appended link parameters will appear as a set of key/value pairs under "link_params", with the key being the parameter name and value being the parameter value. Add any additional link parameters you wish to include to this object. {e.g. "user_email": "{email}"}.

  4. Make a POST request to the template API endpoint using the JSON object modified in step 3 as the request body. This will update the template.

Step 2: Configure the Settings in Console

Now, you need to configure ATS.js in Console to detect and resolve email addresses passed through the ESP.

  1. From Console, select the "ATS" tab in the navigation menu.

  2. Select the "Web" tab.

  3. Click on the name of the desired configuration.

  4. Select the "Obtain Identifier" tab in the navigation menu.

  5. Select Detect Mode (or Direct & Detect) as your Operation Mode.

  6. In the Obtain the Identifier Using drop-down, select "URL Detection".

  7. Fill in the URL Parameters field with the query parameter you added in Step 1, e.g. user_id.

  8. Click Advanced and select "Email" for the Detection Subject.

  9. Select the "Envelope Settings" tab in the navigation menu.

  10. In the Envelope Storage area, select "Local Storage" or "Cookie".

  11. Click Publish.

  12. Send a test email to yourself to confirm that everything is working as expected.

In this section: