POST api/Notifications/SendNotification?notificationSerial={notificationSerial}&notificationRecipient={notificationRecipient}&userID={userID}&appointmentID={appointmentID}

Sends a single Notification via email. Uses "~/App_Data/Notifications/(Notification.Serial)[.source][.culture].xml" as template where [.source] and [.culture] are optional. Valid Site context must exist for SiteAdmin and RegularSiteUsers recipients to be used. Valid Site context exists when an Access Token is created with User context (Resource Owner, Authorization Code, Implicit grants).

Request Information

Parameters

NameDescriptionAdditional information
notificationSerial 
Unique serial number of the Notification to send (type of Notification). Please query '/odata/$metadata' for available enumeration values.

Define this parameter in the request URI.
notificationRecipient 
One of the supported Notification Recipient values. Please query '/odata/$metadata' for available enumeration values.

Define this parameter in the request URI.
data 
Extra data for a Notification. Placed in %Data% section of the template. Optional.

Define this parameter in the request body.
userID 
Unique ID of a User to whom to send the Notification exclusively when notificationRecipient is set to 'SingleUser'. Optional.

Define this parameter in the request URI.
appointmentID 
Unique ID of the Appointment whose attendees (not site owner) are being notified. Optional.

Define this parameter in the request URI.

Request body formats

application/json, text/json

Sample: 
"sample string"

application/xml, text/xml

Sample: 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string</string>

Response Information

Response body formats

application/json, text/json

Sample: 
true

application/xml, text/xml

Sample: 
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>