Create System Notification REST Endpoint

Ben Tiedt — Fri, 08 Mar 2024 17:48:56 GMT

Current Revision posted to API Documentation by Ben Tiedt on 03/08/2024 17:48:56

POST api.ashx/v2/systemnotifications.{json|xml}

Enables external applications to send system notifications to specific users, system administrators, or group owners. If GroupId is set, the calling user must have Modify Group permissions to send a notification. If GroupId is not set, the calling user must have Manage Settings permissions.

Request Parameters

Name	Type	Location	Description	Required	Default
Body	string	Request Body	The body of the notification	Required
EnableDistribution	bool	Request Body	Enables the system notification to be sent to recipients. If disabled, the notification will only show on the community site.	Optional	True
GroupId	int	Request Body	The ID of the group to send to. If omitted, the notification is sent to site administrators.	Optional
GroupingKey	string	Request Body	User generated key used to group duplicate notifications of the same type. Optional.	Optional
IsResolvable	bool	Request Body	Identifies whether this notification is user-resolvable. When true, it can only be resolved by the Service User.	Optional	True
Subject	string	Request Body	The subject of the notification	Required
UserIds	string	Request Body	A comma-separated list of users to send the message to. If omitted, the notification is sent to site administrators	Optional

Example Requests

Widget Javascript

jQuery.telligent.evolution.post({
	url: jQuery.telligent.evolution.site.getBaseUrl() + 'api.ashx/v2/systemnotifications.json',
	data: { 
		'Body': 'body',
		'Subject': 'subject'
	}
}).then(function(response) {
	// use response
});