POST v1/Notifications/Send

Send a notification alert with growl

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	string	None.
Data	string	None.
NotificationType	string	None.
Description	string	None.
To	Recipient	None.
CreatedOn	date	None.
DueWhen	string	None.
Category	string	None.
CreatedBy	string	None.
Read	boolean	None.
Status	string	None.
Payload	string	None.
UnixTime	decimal number	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "sample string 1",
  "Data": "sample string 2",
  "NotificationType": "sample string 3",
  "Description": "sample string 4",
  "To": {
    "TenantId": "sample string 1",
    "UserId": "sample string 2",
    "UniqueName": "tnt:sample string 1:usr:sample string 2"
  },
  "CreatedOn": "2025-01-21T14:00:48.8172766+00:00",
  "DueWhen": "sample string 6",
  "Category": "sample string 7",
  "CreatedBy": "sample string 8",
  "Read": true,
  "Status": "sample string 10",
  "Payload": "sample string 11",
  "UnixTime": 1737468048817.2766
}

application/xml, text/xml

Sample:

<NotificationMessage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NotificationServer.DataModels.Messages">
  <Category>sample string 7</Category>
  <CreatedBy>sample string 8</CreatedBy>
  <CreatedOn>2025-01-21T14:00:48.8172766+00:00</CreatedOn>
  <Data>sample string 2</Data>
  <Description>sample string 4</Description>
  <DueWhen>sample string 6</DueWhen>
  <Id>sample string 1</Id>
  <NotificationType>sample string 3</NotificationType>
  <Payload>sample string 11</Payload>
  <Read>true</Read>
  <Status>sample string 10</Status>
  <To>
    <TenantId>sample string 1</TenantId>
    <UserId>sample string 2</UserId>
  </To>
</NotificationMessage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json

Sample:

true

application/xml, text/xml

Sample:

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