Zum Hauptinhalt springen
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 blacklistAdd werden die Fehlermeldungen definiert, die beim Hinzufügen einer E-Mail-Adresse zur Blacklist (Sperrliste) ausgegeben werden.

​
Beispielkonfiguration

{
  "errorCodes": {
    "missingEmail": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "actionNotAllowed": "<Textbaustein>"
  }
}

​
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.

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": "<Textbaustein>",
    "invalidField": "<Textbaustein>",
    "invalidTargetGroupId": "<Textbaustein>",
    "deactivatedTargetGroup": "<Textbaustein>",
    "actionNotAllowed": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "internalError": "<Textbaustein>"
  }
}

​
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": "<Textbaustein>",
    "missingTargetGroupId": "<Textbaustein>",
    "invalidTargetGroupId": "<Textbaustein>",
    "actionNotAllowed": "<Textbaustein>",
    "internalError": "<Textbaustein>"
  }
}

​
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.

missingTargetGroupIdstringFehlermeldung, die ausgegeben wird, wenn keine Newsletter-Gruppe zur Abmeldung angegeben wurde.

invalidTargetGroupIdstringFehlermeldung, die ausgegeben wird, wenn eine ungültige oder unbekannte Newsletter-Zielgruppe übermittelt wurde.

actionNotAllowedstringFehlermeldung, die ausgegeben wird, wenn die Aktion nicht erlaubt ist.

internalErrorstringFehlermeldung, die ausgegeben wird, wenn unerwartete Systemfehler während der Abmeldung vom Newsletter auftreten.