Get one BusinessAnnouncement

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

import requests

url = "https://spaces.nexudus.com/api/content/businessannouncements/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/businessannouncements/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

OnlyForContacts	OnlyForMembers	Audience
false	false	All customers (contacts and members)
true	false	Contacts only (no active contract)
false	true	Members 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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/businessannouncements/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/businessannouncements/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Business name.

string

Announcement title.

boolean

Whether the announcement is active and visible to customers.

string

Current image file name.

string

URL of a new image to upload (ideal size 600x350 pixels, 12:7 aspect ratio).

boolean

Set to true to remove the current image file.

string

Announcement body text (plain text only, no formatting).

boolean

Whether to display a call-to-action button in the announcement.

string

Text displayed on the call-to-action button.

string

URL the call-to-action button redirects to (must start with https://).

boolean

Whether to send a push notification to customers when the announcement is published.

string

Text of the push notification sent to customers.

string

Date from which the announcement is visible to customers (publish from).

string

Date until which the announcement is visible to customers (publish to).

boolean

Restrict announcement visibility to contacts (customers without an active contract).

boolean

Restrict announcement visibility to members (customers with an active contract).

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple BusinessAnnouncementsRetrieve multiple BusinessAnnouncement records by their Ids in a single request.

Get one BusinessAnnouncement

curl --request GET \
  --url https://spaces.nexudus.com/api/content/businessannouncements/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/businessannouncements/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/businessannouncements/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200