Capture Newsletter Signup

swellAPI.captureNewsletterSignup(email, successCB, errorCB)

This method takes an email address to capture and will record it as having participated in the newsletter signup campaign. This is useful if you want to use an existing newsletter signup form but still record the capture in Swell.

// probably not the best example but simple way to accomplish capture
  $(document).on("swell:setup", function(){
    var existingEmailField = $("#my-esp-email-field");
    var existingSubmitBtn = $("#my-esp-submit-btn");

    $(existingSubmitBtn).click(function(){
      var email = existingEmailField.val();
      swellAPI.captureNewsletterSignup(email);
    });
  });

  // ideally your ESP would emit an event when capture was successful
  $(document).on("swell:setup", function(){
    $(document).on("esp:captured:email", function(email){
      swellAPI.captureNewsletterSignup(email);
    });
  })

Parameters

Parameter

Type

Description

email

string

The email address of the user to be signed up to the newsletter

successCB

function

The function to be called if the signup is successful

errorCB

function

The function to be called if the signup is unsuccessful