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

Feed Elements, Post and Search

Post feed elements and search all feed elements in an organization.
Resource
1/chatter/feed-elements
Available version
31.0
Requires Chatter
Yes
HTTP methods
GET, POST
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
page String Specifies the page token to be used to view a page of information. Page tokens are returned as part of the response class, such as currentPageToken or nextPageToken. If you pass in null, the first page is returned. Optional 31.0
pageSize Integer Specifies the number of feed elements per page. Valid values are between 1 and 100. If you pass in null, the default size is 25. Optional 31.0
q String One or more keywords to search for in the feed elements visible to the context user. The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See Wildcards. Required 31.0
recentCommentCount Integer The maximum number of comments to return with each feed element. The default value is 3. Optional 31.0
sort String Specifies the order returned by the sort, such as by date created or last modified:
  • CreatedDateDesc—Sorts by most recent creation date.
  • LastModifiedDateDesc—Sorts by most recent activity.
 Optional 31.0
Response body for GET
Feed Element Page
Request body for POST
Feed Item Input
Request parameters for POST
Parameter Name Type Description Required or Optional Available Version
feedElementType String Feed elements are the top-level items that a feed contains. Feeds are feed element containers.

The only possible value is FeedItem.

 Required 31.0
originalFeed​ElementId String If this feed element is shared, this is the original feed element 18-character ID. Optional 31.0
subjectId String The ID of the parent this feed element is being posted to. This value can be the ID of a user, group, or record, or the string me to indicate the context user. Required 31.0
text String Text of the feed element. Required 31.0
visibility String Specifies the type of users who can see a feed element.
  • AllUsers—Visibility is not limited to internal users.
  • InternalUsers—Visibility is limited to internal users.
 Optional 31.0
Response body for POST
Feed Item
Example for POST
This example posts text that mentions a user:
1POST /chatter/feed-elements
2
3{ 
4   "body" : {
5      "messageSegments" : [
6         {
7            "type" : "Text",
8            "text" : "When should we meet for release planning? "
9         },
10         {   
11            "type" : "Mention",
12            "id" : "005D00000016Qxp"
13         }]
14       },
15   "feedElementType" : "FeedItem",
16   "subjectId" : "005D00000016Qxp"
17}