Newsletter

A set of methods to subscribe users to email newsletters, update their preferences, and check their subscription status.

create

Creates a new newsletter subscription for a specific email. Emits the PelcroNewsletterCreated DOM events when the response is returned successfully.

window.Pelcro.newsletter.create({
  email: "[email protected]",
}, (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const newsletter = response.data;
  console.log(newsletter);
});

Parameters

ParameterType
email string
sourcestring
listsstring
postal_codestring
consent_urlstring
consent_textstring
consent_typestring

getByEmail

Get the subscribed newsletter for a specific email.

window.Pelcro.newsletter.getByEmail("[email protected]", (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const orderSummary = response.data.plan;
  console.log(orderSummary);
});)

update

Update the newsletter subscription for a specific email.

window.Pelcro.newsletter.update({
  email: "[email protected]",
}, (error, response) => {
  if (error) {
    return console.log("error", error.message);
  }

  const newsletter = response.data;
  console.log(newsletter);
});

Parameters

ParameterType
email string
sourcestring
listsstring
postal_codestring
consent_urlstring
consent_textstring
consent_typestring

isSubscribedToNewsletter

Check if the user is subscribed to the newsletter

const isSubscribedToNewsletter = window.Pelcro.newsletter.isSubscribedToNewsletter();
console.log(isSubscribedToNewsletter);