ConnectApi.ScheduledRecommendationInput

A scheduled recommendation.
Property 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 35.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 35.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 to create a scheduled recommendation

You can’t specify a recommendation​DefinitionId when updating an existing scheduled recommendation.

35.0
Ranking scheduled recommendations example

If you have these scheduled recommendations:

Scheduled Recommendations Rank
ScheduledRecommendationA 1
ScheduledRecommendationB 2
ScheduledRecommendationC 3

And you include this information in the Scheduled Recommendation Input:

Scheduled Recommendation Rank
ScheduledRecommendationD 2

The result is:

Scheduled Recommendation Rank
ScheduledRecommendationA 1
ScheduledRecommendationD 2
ScheduledRecommendationB 3
ScheduledRecommendationC 4
Previous
Next