Loading...
Skip to main content

Preferences Editor

Use the Preferences Editor to create and configure individual Subscription topics and Preference Sections.

Preferences Editor

Subscription Topics​

Subscription Topics are categories of notifications that users can opt-in and out of. For example, welcome and onboarding notifications could be mapped to an Onboarding topic.

info

A notification template can only be mapped to a single subscription topic.

Configuration​

You can set topic properties like Name, the Section it will be in, and its Default State.

Subscription Topic Settings

Default State​

The Default State defines whether a topic can be opted in or out, and whether it's always required.

  • On - Users who do not take any action will automatically receive notifications in this grouping.
  • Off - Users will not receive these notifications unless they change their preferences.
  • Required - Users will not be able to opt-out of these notifications.

Preference Sections​

Preference Sections group subscription topics together and determine which topic delivery channels users can opt in/out of.

Delivery Channel Selection​

Business Tier

Channel Selection is a Courier Business feature. Contact sales for more details.

Delivery Channel Selection gives recipients the ability to select and set the preference for their preferred delivery channel from the Preferences Hosted page.

Channel selection must be enabled for the subscription topic in order for users to customize their delivery channel preferences.

Preference Section Settings
Hosted Page Channel Selection

Channel Delivery Customization & Preferences API​

custom_routing

The custom_routing array in the user preferences API response indicates the user's custom channel delivery. Channel Delivery Customization must be enabled to use custom_routing.

{
	"topic": {
		"custom_routing": [
			"email",
			"push",
			"webhook"
		],
		"has_custom_routing": true,
		"default_status": "OPTED_IN",
		"section_id": "5p8ROfompcN6Sg_2WR92A",
		"section_name": "Notifications",
		"status": "OPTED_IN",
		"topic_id": "FPPGTQRQTRM8TSPZGZAY9296WB37",
		"topic_name": "SMS"
	}
}

How to Map a Notification Template to a Subscription Topic​

There are three ways to map a notification template to a subscription topic:

Topic Settings​

In the Subscription Topic Settings, you can select one or more notification templates.

Linked Notifications in Subscription Topic Settings

Template Creation​

When creating a new notification, you can select a subscription topic.

New Notification Modal

Notification Settings​

In the Notification Designer, you can select a subscription topic.

Notification Settings in the Notification Designer