Scheduled Recommendation

Only community managers (users with the “Create and Set Up Communities” or “Manage Communities” permission) and users with the “Modify All Data” permission can access and create custom recommendations. These recommendations are available only in feeds in communities using the Napili or Salesforce Tabs + Visualforce template in Salesforce1 and via Chatter REST API.

Resource

1/connect/scheduled-recommendations/scheduledRecommendationId

1/connect/communities/communityId/scheduled-recommendations/scheduledRecommendationId

Available version

33.0

Requires Chatter

No

HTTP methods

GET, HEAD, PATCH, DELETE

Request body for PATCH

JSON example for creating a new scheduled recommendation

1{
2   "rank" : "2",
3   "recommendationDefinitionId" : "0RDD00000004CEhOAM"}

JSON example for updating an existing scheduled recommendation

1{   "rank" : "2"}

Properties

Name	Type	Description	Required or Optional	Available Version
rank	Integer	Relative rank of the scheduled recommendation indicated by ascending whole numbers starting with 1. Setting the rank is comparable to an insertion into an ordered list. The scheduled recommendation is inserted into the position specified by the rank. The rank of all the scheduled recommendations after it is pushed down. See Ranking scheduled recommendations example. If the specified rank is larger than the size of the list, the scheduled recommendation is put at the end of the list, and the rank of the scheduled recommendation is the size of the list, instead of the one specified. If a rank is not specified, the scheduled recommendation is put at the end of the list.	Optional	33.0
recommendation​DefinitionId	String	ID of the recommendation definition that is scheduled by this scheduled recommendation.	Required for creating a new scheduled recommendation. You can’t specify a recommendation​DefinitionId when updating an existing scheduled recommendation.	33.0

Request parameters for PATCH

Parameter Name	Type	Description	Required or Optional	Available Version
rank	Integer	Relative rank of the scheduled recommendation indicated by ascending whole numbers starting with 1. Setting the rank is comparable to an insertion into an ordered list. The scheduled recommendation is inserted into the position specified by the rank. The rank of all the scheduled recommendations after it is pushed down. See Ranking scheduled recommendations example. If the specified rank is larger than the size of the list, the scheduled recommendation is put at the end of the list, and the rank of the scheduled recommendation is the size of the list, instead of the one specified. If a rank is not specified, the scheduled recommendation is put at the end of the list.	Optional	33.0

Response body for PATCH

Scheduled Recommendation

Response for DELETE

204: Successful Delete

Deleting a scheduled recommendation is comparable to a deletion in an ordered list. All scheduled recommendations after the deleted scheduled recommendation receive a new, higher rank automatically.