core_v2_systemNotification Script API

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

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

Enables scripted content fragments to send system notifications

Create

Methods

Create

Create Overload 1

Creates a system notification

Velocity

#set($additionalInfoResponse = $core_v2_systemNotification.Create($subject, $body))

JavaScript

var additionalInfoResponse = core_v2_systemNotification.Create(subject, body);

Parameters

Name	Type	Description	Required	Default	Options
subject	`String`	Subject	Required
body	`String`	Body	Required

Create Overload 2

Creates a system notification

Velocity

#set($additionalInfoResponse = $core_v2_systemNotification.Create($subject, $body, "%{ GroupId = $groupIdArg, GroupingKey = $groupingKeyArg, UserIds = $userIdsArg }"))

JavaScript

var additionalInfoResponse = core_v2_systemNotification.Create(subject, body, { GroupId: groupIdArg, GroupingKey: groupingKeyArg, UserIds: userIdsArg });

Parameters

Name	Type	Description	Required
subject	`String`	Subject	Required
body	`String`	Body	Required
GroupId	`Int32`	Identifier of the group to target for this notification	Optional
GroupingKey	`Int32`	Identifier of the notification for future grouping of duplicate occurrences	Optional
UserIds	`Array of Int32`	Comma-separated list of users to send thie notification to	Optional

Returns

[[AdditionalInfo Script API Type|AdditionalInfo]]