Create SystemNotification

POST

api

sys

systemnotifications

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

import requests

url = "https://spaces.nexudus.com/api/sys/systemnotifications"

payload = {
    "Title": "<string>",
    "Severity": 123,
    "StartTime": "<string>",
    "ShortDescription": "<string>",
    "Description": "<string>",
    "MessageType": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Title: '<string>',
    Severity: 123,
    StartTime: '<string>',
    ShortDescription: '<string>',
    Description: '<string>',
    MessageType: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/systemnotifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

eSystemNotificationSeverity — Severity values

Value	Name
1	Low
2	Medium
3	High

eSystemNotificationMessageType — MessageType values

Value	Name
1	Issue
2	Announcement

Request Body

Required Fields

string

required

The title value for this system notification.

integer

required

The severity value for this system notification.

string

required

Date/time value for start time.

string

required

The short description value for this system notification.

string

required

Free-text description of this system notification.

integer

required

The message type value for this system notification.

Optional Fields

string

Date/time value for publish on.

string

Date/time value for un publish on.

string

The resolution description value for this system notification.

boolean

Whether resolved is enabled.

string

Date/time value for resolved on.

boolean

Whether display to admins is enabled.

string

The display to setting integrations value for this system notification.

string

The display to setting general value for this system notification.

string

The display to portal version value for this system notification.

boolean

Whether has button is enabled.

string

The button label value for this system notification.

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

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/systemnotifications',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      Title: '',
      Severity: 0,
      StartTime: '2025-01-15T10:30:00Z',
      ShortDescription: '',
      Description: '',
      MessageType: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/systemnotifications',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'Title': '',
        'Severity': 0,
        'StartTime': '2025-01-15T10:30:00Z',
        'ShortDescription': '',
        'Description': '',
        'MessageType': 0
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the systemnotification was created successfully.

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

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

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
}

Update SystemNotificationUpdate an existing SystemNotification record.

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

import requests

url = "https://spaces.nexudus.com/api/sys/systemnotifications"

payload = {
    "Title": "<string>",
    "Severity": 123,
    "StartTime": "<string>",
    "ShortDescription": "<string>",
    "Description": "<string>",
    "MessageType": 123
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    Title: '<string>',
    Severity: 123,
    StartTime: '<string>',
    ShortDescription: '<string>',
    Description: '<string>',
    MessageType: 123
  })
};

fetch('https://spaces.nexudus.com/api/sys/systemnotifications', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400