actions - Newsletter - WEBSALE Dokumentation

This page contains all actions relating to newsletter dispatch.
Here you will find all messages and email templates for newsletter subscriptions and unsubscriptions as well as for entries in blocklists.

**Fehlertexte sind schreibgeschützt.** Die Fehlercode-Felder auf dieser Seite enthalten den Namen eines Textbausteins (ws.error.<configId>.<errorCode>), nicht den Fehlertext. Gepflegt wird der Text ausschließlich im Textbaustein-Dienst des Admin-Interface – Änderungen an der Konfiguration werden beim Speichern abgewiesen, auch über die [REST API](/schnittstellen/admin-interface-api/api-referenz-konfiguration). E-Mail-Vorlagen sind nicht betroffen.

Overview of the actions

The actions listed here are grouped thematically to present the associated error messages and email templates in a clear structure. Actions that belong to another topic area can be found in the corresponding sections of this documentation or in the alphabetical overview of the actions.

Excerpt of the basic `actions` structure

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

Action overview

Action	Description
`blacklistAdd`	Defines the error messages output when adding an email address to the blacklist.
`newsletterSubscribe`	Defines the error messages output when subscribing to the newsletter and when confirming the subscription.
`newsletterUnsubscribe`	Defines the error messages output when unsubscribing from the newsletter.

`actions.blacklistAdd` - Add recipient to a blacklist

The blacklistAdd action defines the error messages output when adding an email address to the blacklist (blocklist).

Example configuration

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

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`missingEmail`	string	Error message output when no email address was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`emailCheckFailed`	string	Error message output when the supplied email address was considered invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`actionNotAllowed`	string	Error message output when the action is not allowed. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

The newsletterSubscribe action defines the error messages output when subscribing to the newsletter. The error codes actionNotAllowed and internalError are also used by the confirmation action NewsletterSubscribeConfirm, for example in the case of an invalid opt-in link or when a changed email address cannot be transferred to the existing subscriber.

Example configuration

{
  "errorCodes": {
    "missingField": "<Textbaustein>",
    "invalidField": "<Textbaustein>",
    "invalidTargetGroupId": "<Textbaustein>",
    "deactivatedTargetGroup": "<Textbaustein>",
    "actionNotAllowed": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "internalError": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`missingField`	string	Error message output when at least one required field has not been filled in. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidField`	string	Error message output when a field contains an invalid value. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidTargetGroupId`	string	Error message output when an invalid or unknown newsletter target group was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`deactivatedTargetGroup`	string	Error message output when the requested newsletter target group is deactivated in the system. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`actionNotAllowed`	string	Error message output when the action is not allowed. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`emailCheckFailed`	string	Error message output when the supplied email address was considered invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`internalError`	string	Error message output when unexpected system errors occur during the newsletter subscription. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

The newsletterUnsubscribe action defines the error messages output when unsubscribing from the newsletter.

Example configuration

{
  "errorCodes": {
    "missingEmail": "<Textbaustein>",
    "missingField": "<Textbaustein>",
    "missingTargetGroupId": "<Textbaustein>",
    "invalidTargetGroupId": "<Textbaustein>",
    "actionNotAllowed": "<Textbaustein>",
    "internalError": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
`errorCodes`	object	Configures the error codes used for problems during the action.
`missingEmail`	string	Error message output when no email address was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingField`	string	Error message output when a required field has not been filled in. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`missingTargetGroupId`	string	Error message output when no newsletter group was specified for unsubscription. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`invalidTargetGroupId`	string	Error message output when an invalid or unknown newsletter target group was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`actionNotAllowed`	string	Error message output when the action is not allowed. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
`internalError`	string	Error message output when unexpected system errors occur during the newsletter unsubscription. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

​Overview of the actions

​Excerpt of the basic actions structure

​Action overview

​actions.blacklistAdd - Add recipient to a blacklist

​Example configuration

​Parameter overview

​actions.newsletter* - Newsletter

​actions.newsletterSubscribe - Newsletter subscription

​Example configuration

​Parameter overview

​actions.newsletterUnsubscribe - Newsletter unsubscription

​Example configuration

​Parameter overview

Overview of the actions

Excerpt of the basic `actions` structure

Action overview

`actions.blacklistAdd` - Add recipient to a blacklist

Example configuration

Parameter overview

`actions.newsletter*` - Newsletter

`actions.newsletterSubscribe` - Newsletter subscription

Example configuration

Parameter overview

`actions.newsletterUnsubscribe` - Newsletter unsubscription

Example configuration

Parameter overview