Skip to main content
GET
/
api
/
content
/
businessannouncements
/
{id}
Get one BusinessAnnouncement
curl --request GET \
  --url https://spaces.nexudus.com/api/content/businessannouncements/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "Active": true,
  "ImageFileName": "<string>",
  "NewImageUrl": "<string>",
  "ClearImageFile": true,
  "Body": "<string>",
  "ShowButton": true,
  "ButtonLabel": "<string>",
  "ButtonUrl": "<string>",
  "SendPushNotification": true,
  "PushNotificationText": "<string>",
  "ActiveFrom": "<string>",
  "ActiveTo": "<string>",
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<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-Read role.

​
Path Parameters

​
id
integer
required
The Id of the BusinessAnnouncement record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/businessannouncements/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
BusinessName
string
Business name.
​
Name
string
Announcement title.
​
Active
boolean
Whether the announcement is active and visible to customers.
​
ImageFileName
string
Current image file name.
​
NewImageUrl
string
URL of a new image to upload (ideal size 600x350 pixels, 12:7 aspect ratio).
​
ClearImageFile
boolean
Set to true to remove the current 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).
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "Active": false,
  "ImageFileName": null,
  "NewImageUrl": null,
  "ClearImageFile": null,
  "Body": null,
  "ShowButton": false,
  "ButtonLabel": null,
  "ButtonUrl": null,
  "SendPushNotification": false,
  "PushNotificationText": null,
  "ActiveFrom": null,
  "ActiveTo": null,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "BusinessAnnouncement Example",
  "LocalizationDetails": null,
  "CustomFields": null
}