BusinessAnnouncements
Get one BusinessAnnouncement
Retrieve a single BusinessAnnouncement record by its Id.
GET
Get one BusinessAnnouncement
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
Code Examples
Response
200
ID of the location where this announcement is published; a network location makes it available to locations in that network..
Whether this announcement is marked active; the current active-announcement query uses ActiveFrom and ActiveTo rather than this flag..
Whether this announcement is configured to send a push notification; scheduling is currently driven by ActiveFrom on create or update..
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..
Optional UTC publish-until date and time; an announcement remains active only while this value is strictly later than the current UTC time..
Whether the announcement is marked for contacts, meaning customers without an active contract; the current active-announcement query does not apply this audience flag..
Whether the announcement is marked for members, meaning customers with an active contract; the current active-announcement query does not apply this audience flag..
Example Response