Newer Version Available

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

User Recommendations for a Specific Action and Object ID

Returns the recommendation of the specified action and object ID for the logged-in user. Also used to delete a recommendation.

Resource
1/chatter/users/me/recommendations/action/objectID
or
1/chatter/users/userId/recommendations/action/objectID

userId must be the ID of the logged-in user or the alias me.

Note

  • Valid values for action:
    • follow
    • join
    • view (Available in versions 25.0 and later.)
  • Valid values for object ID:
    • If action is follow, object ID is a user ID, file ID, or record ID.
    • If action is join, object ID is a group ID.
    • If action is view, object ID is a user ID, file ID, group ID, or record ID.
Available since version
24.0
HTTP methods
GET, DELETE, or HEAD
DELETE is used to remove a recommendation and is only valid for the following resources:
  • /chatter/users/me | userId/recommendations/follow/recommendedUserId
  • /chatter/users/me | userId/recommendations/follow/recommendedFileId
  • /chatter/users/me | userId/recommendations/follow/recommendedRecordId
  • /chatter/users/me | userId/recommendations/join/recommendedGroupId

userId must be the ID of the logged-in user or the alias me.

Note

Request parameters for GET or HEAD
Parameter Name Type Description
maxResults Integer Maximum number of recommendation results; default is 10. Value must be greater than 0.
followed String ID of a user. Provides new recommendations based on the context of this user ID.
Response body for GET or HEAD without request parameters
Zero or one Recommendation response
Response body for DELETE
204: Successful Delete