Sign in
Announcements

View announcement

Find a single announcement by ID.

get/v1/Announcements/{id}

Path parameters

idinteger required

Format - int32. 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

No recorded changes to this endpoint across all 1 revision of this API.