Skip to main content

Documentation Index

Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt

Use this file to discover all available pages before exploring further.

Diese Seite enthält alle Aktionen, die den Newsletter-Versand betreffen.
Hier finden sich alle Meldungen und E-Mail-Vorlagen für Newsletter-An- und Abmeldungen sowie für Einträge in Sperrlisten.

​
Übersicht der Aktionen

Die hier aufgeführten Aktionen wurden thematisch gruppiert, um die zugehörigen Fehlermeldungen und E-Mail-Vorlagen übersichtlich darzustellen. Aktionen, die inhaltlich zu einem anderen Themenbereich gehören, finden sich in den entsprechenden Abschnitten dieser Dokumentation oder in der alphabetischen Übersicht der Aktionen.

​
Auszug der Grundstruktur actions

{
    "actions": {
      ...
      "blacklistAdd": {...},
      "newsletterSubscribe": {...},
      "newsletterUnsubscribe": {...},
      ...
    }
}

​
Aktionsübersicht

AktionBeschreibung
blacklistAddDefiniert die Fehlermeldungen, die beim Hinzufügen eines Kundenkontos zur Blacklist ausgegeben werden.
newsletterSubscribeDefiniert die Fehlermeldungen, die bei der Anmeldung zum Newsletter ausgegeben werden.
newsletterUnsubscribeDefiniert die Fehlermeldungen, die bei der Abmeldung vom Newsletter ausgegeben werden.

​
actions.blacklistAdd - Empfänger einer Blacklist hinzufügen

Mit der Aktion blacklistAddwerden die Fehlermeldungen definiert, die beim Hinzufügen einer E-Mail-Adresse zur Blacklist (Sperrliste) ausgegeben werden.

​
Beispielkonfiguration

{
  "errorCodes": {
    "missingEmail": "Bitte geben Sie eine E-Mail-Adresse an.",
    "emailCheckFailed": "Die angegebene E-Mail-Adresse ist ungültig.",
    "actionNotAllowed": "Die E-Mail-Adresse kann nicht zur Sperrliste hinzugefügt werden."
  }
}

​
Parameterübersicht

AktionTypBeschreibung
errorCodesobjectKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingEmailstringFehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
emailCheckFailedstringFehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
actionNotAllowedstringFehlermeldung, die ausgegeben wird, wenn die Aktion nicht erlaubt ist.

​
actions.newsletter* - Newsletter

​
actions.newsletterSubscribe - Newsletteranmeldung

Mit der Aktion newsletterSubscribe werden Fehlermeldungen definiert, die bei der Anmeldung zum Newsletter ausgegeben werden.

​
Beispielkonfiguration

{
  "errorCodes": {
    "missingField": "Bitte füllen Sie alle erforderlichen Felder aus.",
    "invalidField": "Mindestens ein Feld ist ungültig ausgefüllt.",
    "invalidTargetGroupId": "Die ausgewählte Newsletter-Gruppe ist ungültig.",
    "deactivatedTargetGroup": "Die ausgewählte Newsletter-Gruppe ist derzeit deaktiviert.",
    "actionNotAllowed": "Eine Newsletter-Anmeldung ist aktuell nicht möglich.",
    "emailCheckFailed": "Die angegebene E-Mail-Adresse ist ungültig.",
    "internalError": "Bei der Newsletter-Anmeldung ist ein Fehler aufgetreten. Bitte versuchen Sie es später erneut."
  }
}

​
Parameterübersicht

ParameterTypBeschreibung
errorCodesobjectKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingFieldstringFehlermeldung, die ausgegeben wird, wenn mindestens ein erforderliches Feld nicht ausgefüllt wurde.
invalidFieldstringFehlermeldung, die ausgegeben wird, wenn ein Feld einen ungültigen Wert enthält.
invalidTargetGroupIdstringFehlermeldung, die ausgegeben wird, wenn eine ungültige oder unbekannte Newsletter-Zielgruppe übermittelt wurde.
deactivatedTargetGroupstringFehlermeldung, die ausgegeben wird, wenn die gewünschte Newsletter-Zielgruppe im System deaktiviert ist.
actionNotAllowedstringFehlermeldung, die ausgegeben wird, wenn die Aktion nicht erlaubt ist.
emailCheckFailedstringFehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
internalErrorstringFehlermeldung, die ausgegeben wird, wenn unerwartete Systemfehler während der Anmeldung zum Newsletter auftreten.

​
actions.newsletterUnsubscribe - Newsletterabmeldung

Mit der Aktion newsletterUnsubscribe werden die Fehlermeldungen definiert, die bei der Abmeldung vom Newsletter ausgegeben werden.

​
Beispielkonfiguration

{
  "errorCodes": {
    "missingEmail": "Bitte geben Sie die E-Mail-Adresse an, die vom Newsletter abgemeldet werden soll.",
    "missingTargetGroupId": "Es wurde keine Newsletter-Gruppe zur Abmeldung angegeben.",
    "invalidTargetGroupId": "Die ausgewählte Newsletter-Gruppe ist ungültig.",
    "actionNotAllowed": "Eine Newsletter-Abmeldung ist aktuell nicht möglich.",
    "internalError": "Bei der Newsletter-Abmeldung ist ein Fehler aufgetreten. Bitte versuchen Sie es später erneut."
  }
}

​
Parameterübersicht

ParameterTypBeschreibung
errorCodesobjectKonfiguriert die Fehlercodes, die bei Problemen während der Aktion verwendet werden.
missingEmailstringFehlermeldung, die ausgegeben wird, wenn keine E-Mail-Adresse übermittelt wurde.
emailCheckFailedstringFehlermeldung, die ausgegeben wird, wenn die angegebene E-Mail-Adresse als ungültig bewertet wurde.
accountAlreadyExistsstringFehlermeldung, die ausgegeben wird, wenn ein Account mit dieser E-Mail-Adresse bereits existiert.
actionNotAllowedstringFehlermeldung, die ausgegeben wird, wenn die Aktion nicht erlaubt ist.