Chatter REST API Developer Guide

Chatter REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Action Links Resources
Activity Reminders
Announcements Resources
Async Query Resources
Clean Resources
Batch Resource
Chatter Resources
Comments Resources
Communities Resources
Communities Knowledge Resources
Communities Moderation Resources
Connect Resources
Content Workspace Permissions Resource
Dashboard Component Snapshot Resource
Datacloud Resources
Environment Hub Resources
Email Merge Field Services Resource
External Email Services Resource
Feed Elements Resources
Feed Items Resources
Feeds Resources
Bookmarks Feed Resources
Communities Direct Message Moderation Feed Resources
Communities Home Feed Resources
Communities Moderation Feed Resources
Company Feed Resources
Direct Messages Feed Resources
Favorites Feed Resources
Feeds Resource
Files Feed Resources
Filter Feed Resources
Groups Feed Resources
Landing Feed Resource
Mute Feed Resources
News Feed Resources
Pending Review Feed Resources
People Feed Resources
Record Feed Resource
Streams Feed Resources
To Feed Resources
Topics Feed Resources
User Profile Feed Resources
Files Connect Repository Resources
Files Resources
Folders Resources
Forecasts Resources
Groups Resources
Influence Resource
Likes Resource
Managed Topics Resources
Mentions Resources
Motifs Resources
Push Notifications Resource
Question and Answers Suggestions Resource
Recommendation Audience Resources
Recommendation Definition Resources
Records Resources
Scheduled Recommendations Resources
Share Captured Activity Resource
Subscriptions Resource
Subscriptions Notifications Member Resource
Topics Resources
User Profiles Resources
Users Resources
Zones Resources
Request Bodies
Response Bodies
Appendices
PDF

Newer Version Available

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

Bookmarks Feed Resources

A feed containing feed elements saved as bookmarks by the context user.
To bookmark an item, use PATCH with the Feed Elements Capability, Bookmarks resource and the isBookmarkedByCurrentUser parameter. For example:

Available resources are:

Resource Description
/chatter/feeds/bookmarks/me Returns the URL for the bookmarks feed for the context user.
/chatter/feeds/bookmarks/me/feed-elements Returns all feed elements bookmarked by the context user.

Bookmarks Feed URL

Returns the URL for the bookmarks feed for the context user.

Resource

userId must be the ID of the context user or the alias me.

Note

Available since version
24.0
Requires Chatter
Yes
HTTP methods
GET or HEAD
Request parameter
Parameter Name Type Description
sort String Specifies the order of feed items in the feed.
  • CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Moderation, and PendingReview feeds.
  • CreatedDateDesc—Sorts by most recent creation date.
  • LastModifiedDateDesc—Sorts by most recent activity.
  • MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
  • Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.
The default value is CreatedDateDesc.
Response body
Feed

Bookmarks Feed Elements

Returns all feed elements bookmarked by the context user.

Resource

userId must be the ID of the context user or the alias me.

Note

Available since version
24.0
Requires Chatter
Yes
HTTP methods
GET or HEAD
Request parameters for GET
Parameter Name Type Description Required or Optional Available Version
density String The density of the feed. One of these values:
  • AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
  • FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

The default value is AllUpdates.

 Optional 31.0
elementsPerBundle Integer Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.

Bundled posts contain feed-tracked changes. In Salesforce for Android and Salesforce for iOS, bundled posts are in record feeds only.

Note

 Optional 31.0
page String A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body, in one of the URL parameters, such as nextPageURL, for example:
Optional 31.0
pageSize Integer Specifies the number of elements per page. Valid values are between 1 and 100. If you don't specify a size, the default is 25. Optional 31.0
q String One or more keywords to search for in the body and comments of feed elements in this feed.

The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See Wildcards.

 Optional 31.0
recentComment​Count Integer Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25. Optional 31.0
sort String Specifies the order of feed items in the feed.
  • CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Moderation, and PendingReview feeds.
  • CreatedDateDesc—Sorts by most recent creation date.
  • LastModifiedDateDesc—Sorts by most recent activity.
  • MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
  • Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.
The default value is CreatedDateDesc.		 Optional 31.0
Response body
Feed Element Page

Bookmarks Feed Items

Returns all feed items bookmarked by the context user.

Resource
OR

userId must be the ID of the context user or the alias me.

Note

Available versions
24.0–31.0

In version 32.0 and later, use Bookmarks Feed Elements.

Important

Requires Chatter
Yes
HTTP methods
GET or HEAD
Request parameters
Parameter Name Type Description Required or Optional Available Version
density String The density of the feed. One of these values:
  • AllUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
  • FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.

The default value is AllUpdates.

 Optional 29.0–31.0
page String A generated token that indicates the view of feed items in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as nextPageURL, for example:
Optional 23.0–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. Optional 23.0–31.0
q String One or more keywords to search for in the body and comments of feed items in this feed.

The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See Wildcards.

 Optional 28.0–31.0
recentComment​Count Integer Maximum number of comments to include per feed item. The default value is 3. The maximum value is 25. Optional 29.0–31.0
sort String Specifies the order of feed items in the feed.
  • CreatedDateAsc—Sorts by oldest creation date. This sort order is available only for DirectMessageModeration, Moderation, and PendingReview feeds.
  • CreatedDateDesc—Sorts by most recent creation date.
  • LastModifiedDateDesc—Sorts by most recent activity.
  • MostViewed—Sorts by most viewed content. This sort order is available only for Home feeds when the ConnectApi.FeedFilter is UnansweredQuestions.
  • Relevance—Sorts by most relevant content. This sort order is available only for Company, Home, and Topics feeds.
The default value is CreatedDateDesc.		 Optional 23.0–31.0
Response body
Feed Item Page

Bookmarks Feed Items Flat

This resource is deprecated as of version 26.0.

Returns a flat feed, that is, a feed where there is no hierarchy between feed items and comments: Feed items and comments are at the same level. All items are returned in chronological order.

Resource
or

userId must be the ID of the context user or the alias me.

Note

Available since version
25.0–26.0
Requires Chatter
Yes
HTTP methods
GET or HEAD
Request parameters
Parameter Name Type Description
numFeedItems Integer Specifies the number of feed items returned. Valid values are from 0 through 100. Default value is 25. Because feed items can include comments, specifying 25 flat feed items may actually return more. For example, if each feed item has one comment, and recentCommentCount is greater than 1, 50 flat feed items are returned.
page String A generated token that indicates the view of feed items in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as nextPageURL.
recentComment​Count Integer Specifies the number of recent comments returned. Valid values are from 0 through 25. Default value is 3.
sort String. One of the following:
  • CreatedDateDesc
  • LastModifiedDateDesc
 Sorts the returned feed either by created date in ascending order, or by last modified date, also in ascending order. The default is LastModifiedDateDesc
Response body
Flat Feed