POST api/Notifications

Create a notification

Request Information

URI Parameters

None.

Body Parameters

WorkPoint365.WebAPI.Model.Notifications.PFNotificationRequestModel

Name	Description	Type	Additional information
Title	Item title	string	Required
NotificationType	Notification Type	string	Required
Status	Notification Status	WorkPoint365.WebAPI.Model.Notifications.NotificationStatus	Required
Priority	Notification Priority	string	Required
Message	Notification Message	string	Required
Deadline	Notification Deadline	date	None.
DeliveryDate	Notification Delivery Date	date	None.
Recipient	Notification Recipient	Object	Required
DuplicateBehaviour	Notification Duplication Behaviour	WorkPoint365.WebAPI.Model.Notifications.NotificationDuplicateBehaviour	Required
BusinessModuleId	Notification Business Module Id	globally unique identifier	Required
EntityId	Notification Entity Id (Context of the notification)	integer	Required
List	Notification List Id or Web Relativ List Url	string	None.
ItemId	Notification Item Id (Context of the notification)	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "Title": "sample string 1",
  "NotificationType": "sample string 2",
  "Status": 0,
  "Priority": "sample string 3",
  "Message": "sample string 4",
  "Deadline": "2026-04-17T04:08:52.9652528+00:00",
  "DeliveryDate": "2026-04-17T04:08:52.9652528+00:00",
  "Recipient": {},
  "DuplicateBehaviour": 0,
  "BusinessModuleId": "50eb87d1-c792-479a-9be3-ba9004784e3a",
  "EntityId": 7,
  "List": "sample string 8",
  "ItemId": 1
}

application/xml, text/xml

Sample:

<PFNotificationRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model.Notifications">
  <BusinessModuleId>50eb87d1-c792-479a-9be3-ba9004784e3a</BusinessModuleId>
  <Deadline>2026-04-17T04:08:52.9652528+00:00</Deadline>
  <DeliveryDate>2026-04-17T04:08:52.9652528+00:00</DeliveryDate>
  <DuplicateBehaviour>CreateNew</DuplicateBehaviour>
  <EntityId>7</EntityId>
  <ItemId>1</ItemId>
  <List>sample string 8</List>
  <Message>sample string 4</Message>
  <NotificationType>sample string 2</NotificationType>
  <Priority>sample string 3</Priority>
  <Recipient />
  <Status>Unread</Status>
  <Title>sample string 1</Title>
</PFNotificationRequestModel>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.