--- schema_version: "1" id: 749e2ac87dccce62ae1c7d586d70f438ebfef6d195558511a1cdaa563f359947 title: Announcements Class collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/apexref/apex_ConnectAPI_Announcements_static_methods.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ConnectAPI_Announcements_static_methods.htm source_site: developer.salesforce.com content_type: documentation content_hash: e48e1d5602eb83bf93226760acf0064c83a054c84aa9c5d35ee98f225f0dc9f7 description: Access information about announcements and post announcements. These methods are for Announcements. All methods are static.Delete an announcement.Get an announcement.Get the first page of announcements.Get a page of announcements.Post an announcement.Update the expiration date of an announcement. --- # Announcements Class Access information about announcements and post announcements. ## Namespace [ConnectApi](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_classes_connect_api.htm "The ConnectApi namespace (also called Connect in Apex) provides classes for accessing the same data available in Connect REST API. Use Connect in Apex to create custom experiences in Salesforce.") ## Usage Use the ConnectApi.Announcements class to get, create, update, and delete announcements. Use an announcement to highlight information. Users can discuss, like, and post comments on announcements. Deleting the feed post deletes the announcement. This image shows an announcement displayed in a group. Creating an announcement also creates a feed item with the announcement text. ![Announcement in the Salesforce UI](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/dev_guides/chatter_connect/images/group_announcement.png) An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement. ## Announcements Methods These methods are for Announcements. All methods are static. All methods in this class require Chatter and are subject to the per user, per namespace, per hour rate limit. - **[deleteAnnouncement(communityId, announcementId)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ConnectAPI_Announcements_static_methods.htm#apex_ConnectAPI_Announcements_deleteAnnouncement)** Delete an announcement. - **[getAnnouncement(communityId, announcementId)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ConnectAPI_Announcements_static_methods.htm#apex_ConnectAPI_Announcements_getAnnouncement)** Get an announcement. - **[getAnnouncements(communityId, parentId)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ConnectAPI_Announcements_static_methods.htm#apex_ConnectAPI_Announcements_getAnnouncements_1)** Get the first page of announcements. - **[getAnnouncements(communityId, parentId, pageParam, pageSize)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ConnectAPI_Announcements_static_methods.htm#apex_ConnectAPI_Announcements_getAnnouncements_2)** Get a page of announcements. - **[postAnnouncement(communityId, announcement)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ConnectAPI_Announcements_static_methods.htm#apex_ConnectAPI_Announcements_postAnnouncement_3)** Post an announcement. - **[updateAnnouncement(communityId, announcementId, expirationDate)](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_ConnectAPI_Announcements_static_methods.htm#apex_ConnectAPI_Announcements_updateAnnouncement)** Update the expiration date of an announcement. ### deleteAnnouncement(communityId, announcementId) Delete an announcement. #### API Version 31.0 #### Requires Chatter Yes #### Signature public static void deleteAnnouncement(String communityId, String announcementId) #### Parameters communityId Type: String ID for an Experience Cloud site, internal, or null. announcementId Type: String An announcement ID, which has a prefix of 0BT. #### Return Value Type: Void #### Usage To get a list of announcements in a group, call [getAnnouncements(communityId, parentId)](#apex_ConnectAPI_Announcements_getAnnouncements_1 "Get the first page of announcements.") or [getAnnouncements(communityId, parentId, pageParam, pageSize)](#apex_ConnectAPI_Announcements_getAnnouncements_2 "Get a page of announcements."). To post an announcement to a group, call [postAnnouncement(communityId, announcement)](#apex_ConnectAPI_Announcements_postAnnouncement_3 "Post an announcement.") . ### getAnnouncement(communityId, announcementId) Get an announcement. #### API Version 31.0 #### Requires Chatter Yes #### Signature public static ConnectApi.Announcement getAnnouncement(String communityId, String announcementId) #### Parameters communityId Type: String ID for an Experience Cloud site, internal, or null. announcementId Type: String An announcement ID, which has a prefix of 0BT. #### Return Value Type: [ConnectApi.Announcement](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_announcement.htm "An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.") #### Usage To get a list of announcements in a group, call [getAnnouncements(communityId, parentId)](#apex_ConnectAPI_Announcements_getAnnouncements_1 "Get the first page of announcements.") or [getAnnouncements(communityId, parentId, pageParam, pageSize)](#apex_ConnectAPI_Announcements_getAnnouncements_2 "Get a page of announcements."). To post an announcement to a group, call [postAnnouncement(communityId, announcement)](#apex_ConnectAPI_Announcements_postAnnouncement_3 "Post an announcement.") . ### getAnnouncements(communityId, parentId) Get the first page of announcements. #### API Version 36.0 #### Available to Guest Users 38.0 #### Requires Chatter Yes #### Signature public static ConnectApi.AnnouncementPage getAnnouncements(String communityId, String parentId) #### Parameters communityId Type: String ID for an Experience Cloud site, internal, or null. parentId Type: String ID of the parent entity for the announcement, that is, a group ID when the announcement appears in a group. #### Return Value Type: [ConnectApi.AnnouncementPage](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_announcementpage.htm#apex_connectapi_output_announcementpage "A collection of announcements.") ### getAnnouncements(communityId, parentId, pageParam, pageSize) Get a page of announcements. #### API Version 36.0 #### Available to Guest Users 38.0 #### Requires Chatter Yes #### Signature public static ConnectApi.AnnouncementPage getAnnouncements(String communityId, String parentId, Integer pageParam, Integer pageSize) #### Parameters communityId Type: String ID for an Experience Cloud site, internal, or null. parentId Type: String ID of the parent entity for the announcement, that is, a group ID when the announcement appears in a group. pageParam Type: Integer Number of the page you want returned. Starts at 0. If you pass in null or 0, the first page is returned. pageSize Type: Integer Specifies the number of announcements per page. #### Return Value Type: [ConnectApi.AnnouncementPage](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_announcementpage.htm#apex_connectapi_output_announcementpage "A collection of announcements.") ### postAnnouncement(communityId, announcement) Post an announcement. #### API Version 36.0 #### Requires Chatter Yes #### Signature public static ConnectApi.Announcement postAnnouncement(String communityId, ConnectApi.AnnouncementInput announcement) #### Parameters communityId Type: String ID for an Experience Cloud site, internal, or null. announcement Type: [ConnectApi.AnnouncementInput](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_input_announcement.htm#apex_connectapi_input_announcement "An announcement.") A ConnectApi.AnnouncementInput object. #### Return Value Type: [ConnectApi.Announcement](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_announcement.htm "An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.") ### updateAnnouncement(communityId, announcementId, expirationDate) Update the expiration date of an announcement. #### API Version 31.0 #### Requires Chatter Yes #### Signature public static ConnectApi.Announcement updateAnnouncement(String communityId, String announcementId, Datetime expirationDate) #### Parameters communityId Type: String ID for an Experience Cloud site, internal, or null. announcementId Type: String An announcement ID, which has a prefix of 0BT. expirationDate Type: Datetime The Salesforce UI displays an announcement until 11:59 p.m. on this date unless another announcement is posted first. The Salesforce UI ignores the time value in the expirationDate. However, you can use the time value to create your own display logic in your own UI. #### Return Value Type: [ConnectApi.Announcement](https://developer.salesforce.com/docs/atlas.en-us.apexref.meta/apexref/apex_connectapi_output_announcement.htm "An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.") #### Usage To get a list of announcements in a group, call [getAnnouncements(communityId, parentId)](#apex_ConnectAPI_Announcements_getAnnouncements_1 "Get the first page of announcements.") or [getAnnouncements(communityId, parentId, pageParam, pageSize)](#apex_ConnectAPI_Announcements_getAnnouncements_2 "Get a page of announcements."). To post an announcement to a group, call [postAnnouncement(communityId, announcement)](#apex_ConnectAPI_Announcements_postAnnouncement_3 "Post an announcement.") .