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 Connect REST API to save a feed search.

Note

Resource
1/chatter/feeds/favorites/userId
1/connect/communities/communityId/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/userId/favoriteId
1/connect/communities/communityId/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 Order of feed items in the feed.
  • CreatedDateAscSorts by oldest creation date. This sort order is available only for DirectMessageModeration, Draft, Isolated, 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.
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 and PATCH
Favorite