actions - Newsletter - WEBSALE Dokumentation

This page contains all actions relating to newsletter dispatch.
Here you will find all messages and email templates for newsletter subscribe/unsubscribe as well as for entries on blocklists.

Overview of actions

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

Excerpt of the basic `actions` structure

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

Action overview

Action	Description
`blacklistAdd`	Defines the error messages that are output when adding a customer account to the blocklist.
`newsletterSubscribe`	Defines the error messages that are output when subscribing to the newsletter.
`newsletterUnsubscribe`	Defines the error messages that are output when unsubscribing from the newsletter.

`actions.blacklistAdd` - Add recipient to a blocklist

The blacklistAdd action defines the error messages that are output when adding an email address to the 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.
`emailCheckFailed`	string	Error message output when the provided email address is considered invalid.
`actionNotAllowed`	string	Error message output when the action is not allowed.

The newsletterSubscribe action defines error messages that are output when subscribing to the newsletter.

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 was not filled in.
`invalidField`	string	Error message output when a field contains an invalid value.
`invalidTargetGroupId`	string	Error message output when an invalid or unknown newsletter target group was supplied.
`deactivatedTargetGroup`	string	Error message output when the requested newsletter target group is disabled in the system.
`actionNotAllowed`	string	Error message output when the action is not allowed.
`emailCheckFailed`	string	Error message output when the provided email address is considered invalid.
`internalError`	string	Error message output when unexpected system errors occur during newsletter subscription.

The newsletterUnsubscribe action defines the error messages that are 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.
`missingField`	string	Error message output when a required field was not filled in.
`missingTargetGroupId`	string	Error message output when no newsletter group for unsubscription was supplied.
`invalidTargetGroupId`	string	Error message output when an invalid or unknown newsletter target group was supplied.
`actionNotAllowed`	string	Error message output when the action is not allowed.
`internalError`	string	Error message output when unexpected system errors occur during newsletter unsubscription.

​Overview of actions

​Excerpt of the basic actions structure

​Action overview

​actions.blacklistAdd - Add recipient to a blocklist

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

Excerpt of the basic `actions` structure

Action overview

`actions.blacklistAdd` - Add recipient to a blocklist

Example configuration

Parameter overview

`actions.newsletter*` - Newsletter

`actions.newsletterSubscribe` - Newsletter subscription

Example configuration

Parameter overview

`actions.newsletterUnsubscribe` - Newsletter unsubscription

Example configuration

Parameter overview