Scheduled Recommendation

Community managers (users with the “Create and Set Up Communities” or “Manage Communities” permission) can access, create, and delete recommendation audiences, recommendation definitions, and scheduled recommendations in their communities. Users with the “Modify All Data” permission can also access, create, and delete recommendation audiences, 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 and anywhere community managers add them using Community Builder in communities using the Summer ’15 or later version of the Napili template.

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
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​AudienceId	String	ID of the audience for this scheduled recommendation. When updating a scheduled recommendation, specify ALL to remove the association between a recommendation audience and a scheduled recommendation.	Optional	35.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 PATCH

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​AudienceId	String	ID of the audience for this scheduled recommendation. When updating a scheduled recommendation, specify ALL to remove the association between a recommendation audience and a scheduled recommendation.	Optional	35.0

Response body for PATCH

Scheduled Recommendation

Request parameters for DELETE

Parameter Name	Type	Description	Required or Optional	Available Version
deleteDefinition​IfLast	Boolean	If true and if the DELETE request is for the last scheduled recommendation of a recommendation definition, deletes the recommendation definition. Default is false.	Optional	35.0

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.