Chatter REST API Developer's Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

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 in the group feed. Group members receive an email notification when you post an announcement, same as for other posts, depending on their selected group email notification frequency. Deleting the feed post deletes the announcement.

To get information about a specific announcement, update the expiration date of an announcement, or delete an announcement, use the Announcements Resource (/chatter/announcements/announcementId).

Resource
1/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 between 1 and 100. If you don't specify a size, the default is 25. 31.0
Request body for POST
Root XML tag
<announcement>
JSON example
1{   "body":
2      {
3         "messageSegments": [
4         {
5            "text": "Please install the updates for all iOS devices.",
6            "type": "Text"
7          }
8          ]
9      }
10   "expirationDate": "2014-02-22T00:00:00.000Z",
11}
Properties
Name Type Description Required or Optional Available Version
body Message Body Input Text of the announcement. Required 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 31.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
Example for POST
This request posts an announcement to a group:
1POST /chatter/groups/0F9D00000000I1d/announcements
This is the request body:
1{   "body":
2      {
3         "messageSegments": [
4         {
5            "text": "Please install the updates for all iOS devices.",
6            "type": "Text"
7          }
8          ]
9      }
10   "expirationDate": "2014-02-22T00:00:00.000Z",
11}