Home B2Core API REST API The Front Office API Announcements

Announcements

Use these methods to manage announcements displayed to clients in the B2Core UI.

GET[host]/api/v2/my/announcements	Get a list of unread announcements
GET[host]/api/v2/my/announcements/{announcementId}	Get announcement details
POST[host]/api/v2/my/announcements/mark-read	Mark all announcements as read
POST[host]/api/v2/my/announcements/{announcementId}/mark-read	Mark an announcement as read

Get a list of unread announcements

Use this method to obtain a list of unread announcements allocated to clients.

Request

Header parameters:

• accept-language: <string>

• Accept: application/json

• Authorization: Bearer <access_token>

GET[host]/api/v2/my/announcements

curl --location --request GET 'https://host.name/api/v2/my/announcements' \
--header 'accept-language: ja' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Response

A response contains an array of Announcement objects providing information about the announcements.

---

Get announcement details

Use this method to obtain detailed information about a specific announcement. This method doesn’t mark a requested announcement as read.

Request

Header parameters:

• accept-language: <string>

• Accept: application/json

• Authorization: Bearer <access_token>

Path parameters:

accountId required

The announcement identifier.

GET[host]/api/v2/my/announcements/{announcementId}

curl --location --request GET 'https://host.name/api/v2/my/announcements/1' \
--header 'accept-language: <string>' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Response

A response includes an Announcement object providing information about the specified announcement.

Mark all announcements as read

Use this method to mark all client announcements as read.

Request

Header parameters:

• accept-language: <string>

• Authorization: Bearer <access_token>

POST[host]/api/v2/my/announcements/mark-read

curl --location --request POST 'https://host.name/api/v2/my/announcements/mark-read' \
--header 'accept-language: ja' \
--header 'Authorization: Bearer <token>'

Response

In case of success, all announcements are marked as read.

---

Mark an announcement as read

Use this method to mark a selected announcement as read.

Request

Header parameters:

• accept-language: <string>

• Authorization: Bearer <access_token>

Path parameters:

announcementId required

The identifier of the announcement.

POST[host]/api/v2/my/announcements/{announcementId}/mark-read

curl --location --request POST 'https://host.name/api/v2/my/announcements/1/mark-read' \
--header 'accept-language: ja' \
--header 'Authorization: Bearer <token>'

Response

In case of success, the selected announcement is marked as read.