Skip to main content
POST
/
api
/
sys
/
systemnotifications
Create SystemNotification
curl --request POST \
  --url https://spaces.nexudus.com/api/sys/systemnotifications \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "Title": "<string>",
  "Severity": 123,
  "StartTime": "<string>",
  "ShortDescription": "<string>",
  "Description": "<string>",
  "MessageType": 123
}
'
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A SystemNotification represents a platform-level notification displayed to administrators, such as billing alerts, integration issues, or system announcements. Notifications have a severity level and message type.

​
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.

​
Enums

ValueName
1Low
2Medium
3High
ValueName
1Issue
2Announcement

​
Request Body

​
Required Fields

​
Title
string
required
The title value for this system notification.
​
Severity
integer
required
The severity value for this system notification.
​
StartTime
string
required
Date/time value for start time.
​
ShortDescription
string
required
The short description value for this system notification.
​
Description
string
required
Free-text description of this system notification.
​
MessageType
integer
required
The message type value for this system notification.

​
Optional Fields

​
PublishOn
string
Date/time value for publish on.
​
UnPublishOn
string
Date/time value for un publish on.
​
ResolutionDescription
string
The resolution description value for this system notification.
​
Resolved
boolean
Whether resolved is enabled.
​
ResolvedOn
string
Date/time value for resolved on.
​
DisplayToAdmins
boolean
Whether display to admins is enabled.
​
DisplayToSettingIntegrations
string
The display to setting integrations value for this system notification.
​
DisplayToSettingGeneral
string
The display to setting general value for this system notification.
​
DisplayToPortalVersion
string
The display to portal version value for this system notification.
​
HasButton
boolean
Whether has button is enabled.
​
ButtonLabel
string
The button label value for this system notification.
​
ButtonUrl
string
The button url value for this system notification.

​
Code Examples

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

​
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
}