Scheduled Recommendations

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, create, and delete recommendation definitions and scheduled recommendations. These recommendations appear directly in the feed in communities in the Salesforce1 mobile browser app. They also appear, by default, on the right side of the home page in communities using the Summer ’15 or later version of the Napili template.

Resource

1/connect/scheduled-recommendations

1/connect/communities/communityId/scheduled-recommendations

Available version

33.0

Requires Chatter

No

HTTP methods

GET, HEAD, POST

Request body for POST

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
enabled	Boolean	Indicates whether scheduling is enabled. If true, the recommendation is enabled and appears in communities. If false, recommendations in feeds in the Salesforce1 mobile browser app aren’t removed, but no new recommendations appear. In communities using the Summer ’15 or later version of the Napili template, disabled recommendations no longer appear.	Optional	34.0
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. 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 this scheduled recommendation schedules.	Required for creating a scheduled recommendation. You can’t specify a recommendation​DefinitionId when updating an existing scheduled recommendation.	33.0

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
enabled	Boolean	Indicates whether scheduling is enabled. If true, the recommendation is enabled and appears in communities. If false, recommendations in feeds in the Salesforce1 mobile browser app aren’t removed, but no new recommendations appear. In communities using the Summer ’15 or later version of the Napili template, disabled recommendations no longer appear.	Optional	34.0
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. 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 this scheduled recommendation schedules.	Required	33.0

Response body for POST

Scheduled Recommendation

Response body for GET

Scheduled Recommendation Collection