Skip to main content
POST
/
api
/
content
/
businessannouncements
{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}
A BusinessAnnouncement is a notification displayed to customers on the members portal and mobile app. Announcements support plain text only (no bold, italics, or lists) and can include an optional image and a call-to-action button. Use ActiveFrom and ActiveTo to schedule when the announcement is visible. Use OnlyForContacts and OnlyForMembers to control the audience:
OnlyForContactsOnlyForMembersAudience
falsefalseAll customers (contacts and members)
truefalseContacts only (no active contract)
falsetrueMembers only (with an active contract)
Announcement images should ideally be 600x350 pixels (12:7 aspect ratio). Set NewImageUrl to a URL to upload a new image, or set ClearImage to true to remove the current image.

​
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 BusinessAnnouncement-Create role.

​
Request Body

​
Required Fields

​
BusinessId
integer
required
Business Id.
​
Name
string
required
Announcement title.

​
Optional Fields

​
Active
boolean
Whether the announcement is active and visible to customers. Defaults to true.
​
NewImageUrl
string
URL of a new image to upload (ideal size 600x350 pixels, 12:7 aspect ratio).
​
ClearImageFile
boolean
Clear Image File.
​
Body
string
Announcement body text (plain text only, no formatting).
​
ShowButton
boolean
Whether to display a call-to-action button in the announcement.
​
ButtonLabel
string
Text displayed on the call-to-action button.
​
ButtonUrl
string
URL the call-to-action button redirects to (must start with https://).
​
SendPushNotification
boolean
Whether to send a push notification to customers when the announcement is published.
​
PushNotificationText
string
Text of the push notification sent to customers.
​
ActiveFrom
string
Date from which the announcement is visible to customers (publish from).
​
ActiveTo
string
Date until which the announcement is visible to customers (publish to).
​
OnlyForContacts
boolean
Restrict announcement visibility to contacts (customers without an active contract).
​
OnlyForMembers
boolean
Restrict announcement visibility to members (customers with an active contract).

​
Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/content/businessannouncements" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": ""
}'

​
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 businessannouncement was created successfully.
​
Errors
array
null on success.
Example Response
{
  "Status": 200,
  "Message": "BusinessAnnouncement 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": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}