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 location announcement shown to customers in the Members Portal and app, with optional plain-text content, image, and call-to-action button. Its public availability is scheduled by UTC ActiveFrom and ActiveTo values.

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 location where this announcement is published; a network location makes it available to locations in that network..

string

Display value for Business.Name..

string

Required title displayed with the announcement..

boolean

Whether this announcement is marked active; the current active-announcement query uses ActiveFrom and ActiveTo rather than this flag..

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

Plain-text announcement body; HTML formatting is not supported..

boolean

Whether to display the optional call-to-action button with this announcement..

string

Text displayed on the call-to-action button when ShowButton is enabled..

string

Destination URL for the call-to-action button when ShowButton is enabled..

boolean

Whether this announcement is configured to send a push notification; scheduling is currently driven by ActiveFrom on create or update..

string

Text configured for the announcement’s push notification..

string

UTC publish-from date and time; the active query requires this value to be strictly earlier than the current UTC time, and create or update schedules its push job at this time..

string

Optional UTC publish-until date and time; an announcement remains active only while this value is strictly later than the current UTC time..

boolean

Whether the announcement is marked for contacts, meaning customers without an active contract; the current active-announcement query does not apply this audience flag..

boolean

Whether the announcement is marked for members, meaning customers with an active contract; the current active-announcement query does not apply this audience flag..

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