Announcement

Get information about, update, or delete an announcement.

Resource

1/chatter/announcements/announcementId

1/connect/communities/communityId/chatter/announcements/announcementId

Available since version

31.0

Requires Chatter

Yes

HTTP methods

GET, PATCH, DELETE, HEAD

Request body for PATCH

Root XML tag

<announcement>

JSON example for updating an announcement

1{
2   "expirationDate": "2016-02-22T00:00:00.000Z",
3   "isArchived": "false"
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 PATCH

Parameter Name	Value	Description	Required or Optional	Available Version
`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	31.0

Response for GET, PATCH

Announcement

Response for DELETE

HTTP Status Code 204

Chatter REST API Developer Guide