Skip to main content

Subscriptions

Subscriptions are quite handy when it comes to sending out information to your customers, think of things like emails, newsletters, and texts. But first, a customer permission is needed, and that can be done via opt-in/out prompts on your front ends. To manage this, what we call "Subscriptions" are needed.

Go to the Subscriptions chapter in the People module of Admin Suite to start configuring your own.


Example: When a new customer profile is being created you'd like front ends to prompt an opt-in/out question to subscribe for the e-mail newsletter. If the user opts in, you'd like to further inquire if they'd like to receive the newsletter e-mail in the morning or evening. To spice it up a bit further, you also want to give users who opt-in a 10% discount coupon.

Authorization

To access this chapter, you need the Subscriptions permission.

Create Subscriptions​

To create a subscription, click the '+' icon in the top right. This button will open a page where you can then configure the subscription to your needs.


A subscription consists of the following fields:

  • Name (required): Give it a name - This will be the name displayed on your front end(s).
  • BackendID (required): Give it a BackendID - Quite handy when using API services.
  • Description (optional): Give it a brief description - This description will be displayed on your front ends under the input pertaining to the name field. Note: If you want to add a hyperlink in the description, use the following format - [Best doc page](https://docs.newblack.io/). Only what is specified between the squared brackets [] would display on your front end(s) as the hyperlinked text, while what is between the parenthesis () only dictates your url/link.
  • Handler (optional): Used to enable confirmations or other custom handling when subscribing/unsubscribing. At the moment only newsletter is available. This mimics the current behavior, sends emails, etc.
  • Loyalty program (optional): You can link your subscription to an already configured Loyalty Program. Note: You can activate the loyalty program payment method once users subscribe by linking a loyalty program.
  • Linked Custom field (optional): Determines which Custom field should be required in the front end.
  • Request from front end (yes/no): This field relates to the handler field. So, when a user identifier is needed for the handler you can request to provide this from the front end by checking this box. The property behind this field is ManualIdentifiers.
  • Inquiry (optional): You can link an Inquiry here. Which then would display on front ends if subscription is opted in for.

After you're done filling in the fields, save your work. Once saved, you'll notice two new cards added: User requirements and Organization unit sets.

tip

You can link a subscription to a promotion using the customer discount condition.

Edit Subscriptions​

To view or to edit an existing subscription, click the desired subscription from the overview. You'll be presented with three cards: General info, User requirements, and Organization unit sets, each covered in more details below.


General info​

Edit any of the fields initially filled in under the General info card at time of creation as well as set translations (if needed) on the front end prompted fields (name and description).

For translations, click the corresponding Translation symbol, and fill in the translated text including country and language.

User requirements​

Not all, but some subscriptions require additional information from your customer to deliver them properly. An example of this would be an email newsletter, which requires an email. If this is not a default user requirement in your environment, you can make special subscription user requirements available. You can use the User requirements card to manage this.


  • Preferred: makes it optional, but the front-end applications will still remind the front end users that it would be good to have.
  • Regular: makes it a requirement.

Organization unit sets​

This card is used to link your subscription to a single or multiple organization unit(s).

Click the '+' icon at the bottom and select the desired OU or OU set.


The modal consists of the following fields:

  • Is active: Determines if the subscription is or is not active for the specified organization unit(s). Based on the choice this will impact where the subscription will be displayed/prompted on front ends or not.
  • Hide from Frontend: Determines if the subscription will be visible on the front end or not.
  • Default selected: Makes the user automatically subscribed instead of needing to do a manual tick to subscribe.
  • Preferred notification: Gives the subscription a preferred note on the front end rather than optional.
  • Confirmation required: A yes would prompt front end users to confirm subscription
  • Priority: Sets the order of the subscription on the front end.