Create CoworkerNotification

POST

api

spaces

coworkernotifications

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkernotifications \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "Message": "<string>",
  "NotificationType": "<string>",
  "EntityId": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkernotifications"

payload = {
    "CoworkerId": 123,
    "Message": "<string>",
    "NotificationType": "<string>",
    "EntityId": 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({
    CoworkerId: 123,
    Message: '<string>',
    NotificationType: '<string>',
    EntityId: 123
  })
};

fetch('https://spaces.nexudus.com/api/spaces/coworkernotifications', 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 CoworkerNotification represents a push notification sent to a customer (coworker). Notifications are generated by the system in response to various events such as new blog posts, community messages, invoices, identity checks, and more. Notifications are read-only — they can be listed and retrieved but not created or modified via the API. The NotificationType field indicates the source event. Common values include:

NotificationType	Meaning
`blog`	New blog post published
`community-event`	Community event update
`community-message`	New community message
`community-thread`	New community thread
`course`	Course update
`coworkerinvoice`	New invoice generated
`identitycheck-fail`	Identity check failed
`identity-check-failed`	Identity check failed (alternate)
`identity-check-success`	Identity check succeeded
`identitycheck-success`	Identity check succeeded (alternate)
`push-notification`	Generic push notification
`reply-like`	Someone liked a reply
`salto-locker`	Salto locker event
`survey`	Survey notification
`thread-like`	Someone liked a thread

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 CoworkerNotification-Create role.

Request Body

Required Fields

integer

required

ID of the coworker linked to this record.

string

required

The notification message body displayed to the coworker.

string

required

The type of event that triggered this notification (e.g. blog, community-event, coworkerinvoice, push-notification).

integer

required

The ID of the entity related to this notification (e.g. the blog post, invoice, or thread that triggered it).

Optional Fields

boolean

Whether the coworker has dismissed this notification.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/coworkernotifications" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "CoworkerId": 0,
    "Message": "",
    "NotificationType": "",
    "EntityId": 0
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/spaces/coworkernotifications',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      CoworkerId: 0,
      Message: '',
      NotificationType: '',
      EntityId: 0
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/spaces/coworkernotifications',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'CoworkerId': 0,
        'Message': '',
        'NotificationType': '',
        'EntityId': 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 coworkernotification was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerNotification 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": "Message: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Message"
    }
  ],
  "WasSuccessful": false
}

Update CoworkerNotificationUpdate an existing CoworkerNotification record.

Create CoworkerNotification

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkernotifications \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "CoworkerId": 123,
  "Message": "<string>",
  "NotificationType": "<string>",
  "EntityId": 123
}
'

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkernotifications"

payload = {
    "CoworkerId": 123,
    "Message": "<string>",
    "NotificationType": "<string>",
    "EntityId": 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({
    CoworkerId: 123,
    Message: '<string>',
    NotificationType: '<string>',
    EntityId: 123
  })
};

fetch('https://spaces.nexudus.com/api/spaces/coworkernotifications', 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

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400

​Authentication

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400