core_v2_notificationUserPreference Script API

Ben Tiedt — Wed, 20 Nov 2019 14:53:44 GMT

Current Revision posted to API Documentation by Ben Tiedt on 11/20/2019 14:53:44

Enables scripted content fragments to use Notification User Preferences

List
Update

Methods

List

Lists notification user preferences

Velocity

#set($notificationUserPreferencesResponse = $core_v2_notificationUserPreference.List())

JavaScript

var notificationUserPreferencesResponse = core_v2_notificationUserPreference.List();

Returns

[[NotificationUserPreferences Script API Type|NotificationUserPreferences]]

Update

Updates a notification user preference

Velocity

#set($additionalInfoResponse = $core_v2_notificationUserPreference.Update($notificationTypeId, $isEnabled, "%{ DistributionTypeId = $distributionTypeIdArg }"))

JavaScript

var additionalInfoResponse = core_v2_notificationUserPreference.Update(notificationTypeId, isEnabled, { DistributionTypeId: distributionTypeIdArg });

Parameters

Name	Type	Description	Required
notificationTypeId	`Guid`	Type of notification type to enable or disable	Required
isEnabled	`Boolean`	Whether to enable or disable	Required
DistributionTypeId	`Guid`	When specified, only enables or disables a specific distribution type for a specific notification type for a user. When not specified. When not specified, the entire notification is enabled or disabled for a user.	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]