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.

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 a customer account to the blacklist.
`newsletterSubscribe`	Defines the error messages output when subscribing to the newsletter.
`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.
`emailCheckFailed`	string	Error message output when the supplied email address was considered invalid.
`actionNotAllowed`	string	Error message output when the action is not allowed.

The newsletterSubscribe action defines the error messages 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 has not been 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 deactivated in the system.
`actionNotAllowed`	string	Error message output when the action is not allowed.
`emailCheckFailed`	string	Error message output when the supplied email address was considered invalid.
`internalError`	string	Error message output when unexpected system errors occur during the newsletter subscription.

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.
`missingField`	string	Error message output when a required field has not been filled in.
`missingTargetGroupId`	string	Error message output when no newsletter group was specified for unsubscription.
`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 the newsletter unsubscription.

​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