Skip to main content
POST
/
api
/
sys
/
systemnotifications
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

​
Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the SystemNotification-Create role.

​
Request Body

​
Required Fields

​
Title
string
required
Title.
​
StartTime
string
required
Start Time.
​
ShortDescription
string
required
Short Description.
​
Description
string
required
Description.

​
Optional Fields

​
Severity
integer
Severity. See eSystemNotificationSeverity enum above.
​
PublishOn
string
Publish On.
​
UnPublishOn
string
Un Publish On.
​
ResolutionDescription
string
Resolution Description.
​
Resolved
boolean
Resolved.
​
ResolvedOn
string
Resolved On.
​
DisplayToAdmins
boolean
Display To Admins.
​
DisplayToSettingIntegrations
string
Display To Setting Integrations.
​
DisplayToSettingGeneral
string
Display To Setting General.
​
DisplayToPortalVersion
string
Display To Portal Version.
​
MessageType
integer
Message Type. See eSystemNotificationMessageType enum above.
​
HasButton
boolean
Has Button.
​
ButtonLabel
string
Button Label.
​
ButtonUrl
string
Button Url.

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/systemnotifications" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "Title": "",
    "StartTime": "2025-01-15T10:30:00Z",
    "ShortDescription": "",
    "Description": ""
}'

​
Response

​
200

​
Status
integer
HTTP status code. 200 on success.
​
Message
string
A human-readable message confirming the creation.
​
Value
object
Contains the Id of the newly created record.
​
WasSuccessful
boolean
true if the systemnotification was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "SystemNotification was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

​
400

​
Message
string
A summary of the validation error(s), in the format PropertyName: error message.
​
Value
any
null on validation failure.
​
Errors
object[]
Array of validation errors.
​
WasSuccessful
boolean
false when the request fails validation.
Example Response
{
  "Message": "Title: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Title"
    }
  ],
  "WasSuccessful": false
}