mailingListEntry.removed

Last modified October 5, 2018

This article applies to Contextual Commerce. (Looking for Classic Commerce documentation?)

The mailingListEntry.removed server webhook event is fired when an entry is expected to be removed from a mailing list, e.g. due to customer unsubscribing by placing an order with the newsletter check box cleared / unselected. Please see Cart Abandonment Tracking and Customer Mailing List Opt-In for more information.

About Webhook Expansion

mailingListEntry.removed is not affected by webhook expansion.

Contents of Event Payload

NameTypeDescription
idstringID of the event
liststringlist from which the email address has been removed
updatedintegerdate on which the list was updated, in milliseconds
emailstringemail address that was removed
firstNamestringfirst name associated with the email address that was removed (if known)
lastNamestringlast name associated with the email address that was removed (if known)

Example

mailingListEntry.removed webhook example
{ 
  "id":"91143a785402b7867f965557e3eaf4e958cfac639c07c4d7b0726bfd6ed0bfbb",
  "list":"subscribed",
  "updated":1462371921845,
  "email":"jdoe@gmail.com",
  "firstName":null,
  "lastName":null
}