Subscribe and unsubscribe process

Note:  This topic is for administrators and developers with administration access rights in Episerver Campaign.

After you completed the steps described under Spryker integration, customers can sign up for newsletters using the newsletter form in your shop. This topic describes which data fields are to be transmitted to Episerver Campaign and how to reference the unsubscribe link in your newsletter to your Spryker e-commerce platform.

Transmitting registration data to Episerver Campaign

The registration data is transmitted via HTTP request to Episerver Campaign. The following data fields are transmitted:

Field name Data type Description Mandatory field
email String Recipient's email address – also the recipient's unique ID
salutation String Title (Mr/Ms) of the recipient
firstname String Recipient's first name
lastname String Recipient's last name
customer_shop_locale String Language of the shop via which the customer has registered (transferred automatically)
spryker_id String Spryker-internal shop customer ID
customer_shop_url String Shop URL of the customer (transferred automatically)
customer_login_url String Login URL of the customer (transferred automatically)
subscriber_key String Individual key of user in Spryker Commerce (transferred automatically)

Referencing the unsubscribe link to Spryker

Recipients of a commercial mailing must have the possibility to easily unsubscribe, see Deliverability best practices. Usually this is guaranteed by an unsubscribe link located in the footer of the newsletter. To redirect the unsubscribe link to Spryker, adjust the field function in the unsubscribe link.

Note:  This example refers to a message template. You must change the unsubscribe link in all mailings that have already been created but not yet sent.

  1. Log in to Episerver Campaign.
  2. Go to start menuMain screen in Episerver Campaign, where the available options are grouped together. > Campaigns > Message templates.
  3. Select the message template you want to edit, and click Edit.
  4. In the Edit message template window, in the left Edit area, click the name of the paragraph that contains the unsubscribe link.
  5. In the right Content area, in the Text field, click Source .
  6. Replace the unsubscribe link with the following code: {Unsubscribe Link}?Subscriber_key={subscriber_key}

    Image: Replacing the unsubscribe link

  7. Click ApplyCloseSave and close.