newsletter - Newsletter - WEBSALE Dokumentation

Der Knoten newsletter bündelt alles rund um Newsletter An- und Abmeldung sowie die dazugehörigen E-Mails. Hier kann beispielsweise festgelegt werden, ob eine Bestätigung (Double-Opt-In) für verschiedene Aktionen nötig ist und wie die E-Mail-Formulare dargestellt werden und was sie beinhalten sollen.

Nachfolgend der Grundaufbau des Knotens newsletter

{
  "newsletter": {
    "field": { },
    "newsletter": { }
  }
}

Parameterbeschreibung

Parameter	Beschreibung
`field`	Definiert ein einzelnes Feld für das Newsletter-Formular.
`newsletter`	Definiert grundlegende Newsletter-Funktionen.

Der Knoten newsletter.field definiert ein einzelnes Feld des Newsletter-Formulars. Man legt damit beispielsweise die Bezeichnung, den Feldtyp sowie Validierungen fest. Das Frontend rendert die Eingabe entsprechend dieser Vorgaben.

Beispielkonfiguration (Feld “Vorname” hinzufügen)

{
  "newsletter": {
    "fields": {
      "firstName": {
        "name": "firstName",
        "label": "<Textbaustein>",
        "required": false,
        "type": "text",
        "validations": [
          {
            "service": "formCheck.minlen",
            "options": {
              "len": 3
            }
          },
          {
            "service": "formCheck.maxlen",
            "options": {
              "len": 50
            }
          }
        ]
      }
    }
  }
}

Parameterbeschreibung

Parameter	Typ	Beschreibung
`name`	string	Technischer Name des Formularfeldes. Muss eindeutig sein und ist selbst wählbar. Wird beim Absenden des Formulars sowie beim Import / Export verwendet.
`label`	string	Anzeigename im Admin-Interface.
`required`	bool	Markiert das Feld als Pflichtfeld. Default: `true`
`type`	enum	Gibt den Feldtyp an. Mögliche Werte: - `text` - Freitextfeld - `salutation` - Auswahl einer im Shop konfigurierten Anrede - `title` - Auswahl eines im Shop konfigurierten Titels
`validations`	multiService	Liste von Validierungsregeln zur Prüfung des Feldinhalts. Wird nur bei Freitextfeldern (`type: text` ) unterstützt. Mehr unter Validierungs- und Prüfservices Target: `inputValidation`

Der Knoten newsletter.newsletter steuert alle grundlegenden Newsletter-Funktionen, zum Beispiel Double-Opt-In und An-/Abmeldung. Es können Templates, Betreffzeilen, Absenderangaben uvm. bestimmt werden.

Beispielkonfiguration

{
  "blacklistSelfDoubleOptIn": true,
  "doubleOptInEmailBlacklist": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Bestätigen Sie Ihre Blacklist Anmeldung",
    "template": "newsletterBlacklist.htm"
  },
  "doubleOptInEmailSubscribe": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Bestätigen Sie Ihre Registrierung",
    "template": "newsletterSubscribe.htm"
  },
  "doubleOptInEmailUnsubscribe": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Bestätigen Sie Ihre Abmeldung",
    "template": "newsletterUnsubscribe.htm"
  },
  "fields": [
    "newsletter.field.firstName",
    "newsletter.field.lastName",
    "newsletter.field.salutation"
  ],
  "importSubscribeDoubleOptIn": true,
  "unsubscribeAdminDoubleOptIn": true,
  "unsubscribeSelfDoubleOptIn": true,
  "welcomeEmail": {
    "fromAddress": "no-reply@websale.de",
    "fromName": "WEBSALE",
    "subject": "Herzlich Willkommen im Newsletter",
    "template": "newsletterWelcome.htm"
  }
}

Parameterbeschreibung

Parameter	Typ	Beschreibung
`blacklistSelfDoubleOptIn`	bool	Wenn sich jemand selbst vom Newsletter abmelden möchte, muss er dies per Bestätigungs-E-Mail (Double-Opt-In) bestätigen. default: `true`
`doubleOptInEmailBlacklist`	object	Einstellungen für die Bestätigungs-E-Mail bei Abmeldung / Sperrung.
`fromAddress`	string	Absender E-Mail der Bestätigungsmail.
`fromName`	string	Absendername der Bestätigungsmail.
`subject`	string	Betreff der Bestätigungsmail.
`template`	string	Name / Datei des E-Mail-Templates, das verwendet werden soll.
`doubleOptInEmailSubscribe`	object	Einstellungen für die Bestätigungs-E-Mail bei Anmeldung zum Newsletter.
`fromAddress`	string	Absender E-Mail der Anmeldemail.
`fromName`	string	Absendername der Anmeldemail.
`subject`	string	Betreff der Anmeldemail.
`template`	string	Name / Datei des E-Mail-Templates, das verwendet werden soll.
`doubleOptInEmailUnsubscribe`	object	Einstellung für die Bestätigungs-E-Mail bei der Abmeldung vom Newsletter.
`fromAddress`	string	Absender E-Mail der Abmeldungsmail.
`fromName`	string	Absendername der Abmeldungsmail.
`subject`	string	Betreff der Abmeldungsmail.
`template`	string	Name / Datei des E-Mail-Templates, das verwendet werden soll.
`fields`	multiAssoc	Verknüpfte Formularfelder für die Anmeldung zum Newsletter. Hier werden die unter `newsletter.field` definierten Felder referenziert. Ein eigenes Feld für E-Mail-Adresse muss nicht angegeben werden - diese wird stets automatisch unter dem Namen `email` übergeben. target: `newsletter.field`
`importSubscribeDoubleOptIn`	bool	Auch importierte E-Mail-Adressen müssen ihre Anmeldung zum Newsletter per Bestätigungs-E-Mail bestätigen. default: `true`
`unsubscribeAdminDoubleOptIn`	bool	Wenn ein Administrator jemanden vom Newsletter abmeldet, muss der Empfänger die Abmeldung per Bestätigungs-E-Mail bestätigen. default: `true`
`unsubscribeSelfDoubleOptIn`	bool	Bei eigener Abmeldung vom Newsletter ist eine Abmeldung per Bestätigungs-E-Mail nötig. default: `true`
`welcomeEmail`	object	Einstellungen für die Willkommens-E-Mail nach erfolgreich Anmeldung zum Newsletter.
`fromAddress`	string	Absender E-Mail der Willkommensmail.
`fromName`	string	Absendername der Willkommensmail.
`subject`	string	Betreff der Willkommensmail.
`template`	string	Name / Datei des E-Mail-Templates, das verwendet werden soll.

Verwandte Themen

Newsletter Konfigurations-Deeplinks $wsNewsletter - Newsletter Storefront API Newsletter API-Referenz Newsletter

⌘I