Announcements

View announcement

Changed on

Find a single announcement by ID.

get/v1/Announcements/{id}

Request

Path parameters

idinteger required

ID of the announcement to view.

Response

OK

okboolean
announcement_idinteger

Primary identifier for this announcement.

created_datestring date-time

Date the announcement was created.

titlestring required

Title of the announcement.

body_htmlstring required

HTML body of the announcement.

enabledboolean required

Whether the announcement is currently enabled.

location'ALL' | 'AGENT_PORTAL' | 'CUSTOMER_PORTAL'

Location of the announcement.

file_idinteger

File ID attached to the announcement.

Changes

    • breaking

      removed the media type application/json for the response with the status

    • breaking

      removed the media type text/html for the response with the status

    • breaking

      removed the media type text/json for the response with the status