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

Favorites Feed Resources

A feed containing favorites saved by the context user.

Favorites are feed searches, list views, and topics that the context user has added as a Chatter favorite.

Available resources are:

Resource Description
/chatter/feeds/favorites/me Returns all the favorites for the context user. Creates a favorite of a Chatter feed search or topic.
/chatter/feeds/favorites/me/favoriteId Returns the feed for the specified favorite. Deletes the specified favorite. Updates the last view date of the specified favorite.
/chatter/feeds/favorites/me/favoriteId/feed-elements Returns a filtered feed, only showing those feed elements for the specified favorite.

List of Favorites

Returns all the favorites for the context user. Creates a favorite of a Chatter feed search or topic.

The response contains feed searches that were saved using the Web UI. However, you can’t use Chatter API to save a feed search.

Note

Resource
1/chatter/feeds/favorites/me
or
1/chatter/feeds/favorites/userId

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, HEAD, or POST
Request body for POST
Root XML tag
<favorite>
JSON for POST
1{ 
2   "searchText" : "release",
3   "targetId" : "0TOD0000000099d"
4}
Properties for POST
Name Type Description Available Version
searchText String Text of the feed search. Use this parameter for feed searches only. 24.0
targetId String Id of the topic. Use this parameter for topics only. 28.0
Request parameters for POST
Name Type Description Available Version
searchText String Text of the feed search. Use this parameter for feed searches only. 24.0
targetId String Id of the topic. Use this parameter for topics only. 28.0
Response body for GET
Favorites Page
Response body for POST
Favorite

Favorite

Returns the feed for the specified favorite. Deletes the specified favorite. Updates the last view date of the specified favorite.

Resource
1/chatter/feeds/favorites/me/favoriteId
or
1/chatter/feeds/favorites/userId/favoriteId

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, HEAD, PATCH, or DELETE
Request parameter for GET or HEAD
Parameter Name Type Description
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.
The default value is CreatedDescDate.
Request body for PATCH
Root XML tag
<favorite>
JSON for PATCH
1{ 
2   "updateLastViewDate" : "true"
3}
Properties for PATCH
Name Type Description Available Version
updateLastViewDate Boolean Sets the last view date of the specified feed favorite to the current system time. Default value is false. 24.0
Request parameter for PATCH
Parameter Name Type Description
updateLastViewDate Boolean Sets the last view date of the specified feed favorite to the current system time. Default value is false.
Response body for GET
Favorite
Response body for PATCH
Favorite

Favorites Feed Items

Returns a filtered feed, only showing those feed items for the specified favorite.

Resource
1/chatter/feeds/favorites/me/favoriteId/feed-items
or
1/chatter/feeds/favorites/userId/favoriteId/feed-items

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 Favorites 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.
  • FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of, 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: 
1"nextPageUrl": 
2"/services/data/v32.0/
3chatter/feeds/news/
4005D0000001GLowIAN
5/feed-items
6?page=2011-03-30T17:34:50Z,
70D5D0000000DSv4KAG"
 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 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.
The default value is CreatedDescDate.		 Optional 23.0–31.0
Response body
Feed Item Page