Group Announcements

Information about the announcements posted to the specified group. Get information or post an announcement to a group.

Use an announcement to highlight information. Users can discuss, like, and post comments on announcements. Deleting the feed post deletes the announcement.

To get information about, update, or delete an announcement, use the Announcements Resources.

Resource

1/chatter/groups/groupID/announcements

1/connect/communities/communityId/chatter/groups/groupID/announcements

Available since version

31.0

Requires Chatter

Yes

HTTP methods

GET, POST, HEAD

Request parameters for GET

Parameter Name	Type	Description	Available Since
`page`	Integer	An integer specifying a page of items. The default value is 0, which returns the first page.	31.0
`pageSize`	Integer	Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.	31.0

Request body for POST

Root XML tag

<announcement>

JSON example for creating an announcement

1{   "body":
2      {
3         "messageSegments": [
4         {
5            "text": "Please install the updates for all iOS devices.",
6            "type": "Text"
7          }
8          ]
9      },
10   "parentId": "0F9B0000000004S",
11   "expirationDate": "2016-02-22T00:00:00.000Z"
12}

JSON example for creating an announcement using an existing feed item

1{
2   "feedItemId": "0D5D0000000DaZBKA0",
3   "expirationDate": "2016-02-22T00:00:00.000Z"
4}

Properties

Name	Type	Description	Required or Optional	Available Version
`body`	Message Body Input	Text of the announcement.	Required for creating an announcement if `feedItemId` isn’t specified Don’t specify for updating an announcement.	31.0
`expirationDate`	Date	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.	Required for creating an announcement Optional for updating an announcement	31.0
`feedItemId`	String	ID of an `AdvancedTextPost` feed item that is the body of the announcement.	Required for creating an announcement if `body` isn’t specified Don’t specify for updating an announcement.	36.0
`isArchived`	Boolean	Specifies whether the announcement is archived.	Optional	36.0
`parentId`	String	ID of the parent entity for the announcement, that is, a group ID when the announcement appears in a group.	Required for creating an announcement if `feedItemId` isn’t specified Don’t specify for updating an announcement.	36.0
`sendEmails`	Boolean	Specifies whether the announcement is sent as an email to all group members regardless of their email setting for the group. If Chatter emails aren’t enabled for the organization, announcement emails aren’t sent. Default value is `false`.	Optional for creating an announcement Don’t specify for updating an announcement	36.0

Request parameters for POST

Parameter Name	Type	Description	Available Since
`expirationDate`	Date	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.	31.0

Response body for GET

Announcement Page

Response body for POST

Announcement

Chatter REST API Developer Guide

Group Announcements