Skip to main content
This page contains all actions related to newsletter dispatch.
All messages and email templates for newsletter sign-ups and sign-offs as well as for entries in blocklists can be found here.

​
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

ActionDescription
blacklistAddDefines the error messages that are output when a customer account is added to the blacklist.
newsletterSubscribeDefines the error messages that are output when signing up for the newsletter.
newsletterUnsubscribeDefines the error messages that are output when unsubscribing from the newsletter.

​
actions.blacklistAdd - Add recipient to a blacklist

The blacklistAdd action defines the error messages that are output when an email address is added to the blacklist (blocklist).

​
Example configuration

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

​
Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingEmailstringError message output when no email address was supplied.

emailCheckFailedstringError message output when the provided email address is considered invalid.

actionNotAllowedstringError message output when the action is not allowed.

​
actions.newsletter* - Newsletter

​
actions.newsletterSubscribe - Newsletter sign-up

The newsletterSubscribe action defines error messages that are output when signing up for the newsletter.

​
Example configuration

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

​
Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingFieldstringError message output when at least one required field has not been filled in.

invalidFieldstringError message output when a field contains an invalid value.

invalidTargetGroupIdstringError message output when an invalid or unknown newsletter target group has been supplied.

deactivatedTargetGroupstringError message output when the desired newsletter target group is deactivated in the system.

actionNotAllowedstringError message output when the action is not allowed.

emailCheckFailedstringError message output when the provided email address is considered invalid.

internalErrorstringError message output when unexpected system errors occur while signing up to the newsletter.

​
actions.newsletterUnsubscribe - Newsletter unsubscribe

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

​
Example configuration

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

​
Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
missingEmailstringError message output when no email address was supplied.

missingTargetGroupIdstringError message output when no newsletter group has been specified for the unsubscribe.

invalidTargetGroupIdstringError message output when an invalid or unknown newsletter target group has been supplied.

actionNotAllowedstringError message output when the action is not allowed.

internalErrorstringError message output when unexpected system errors occur while unsubscribing from the newsletter.