Skip Navigation

Newer Version Available

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

ConnectApi.ScheduledRecommendationInput

A scheduled recommendation.

Property	Type	Description	Required or Optional	Available Version
`channel`	`ConnectApi.RecommendationChannel`	Specifies a way to tie recommendations together, for example, to display recommendations in specific places in the UI or to show recommendations based on time of day or geographic locations. Values are: `CustomChannel1`—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. For example, community managers can use Community Builder to determine where recommendations appear. `CustomChannel2`—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. `CustomChannel3`—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. `CustomChannel4`—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. `CustomChannel5`—Custom recommendation channel. Not used by default. Work with your community manager to define custom channels. `DefaultChannel`—Default recommendation channel. Recommendations appear by default on the Napili community home and question detail pages and in the feed in communities in the Salesforce1 mobile browser app. They also appear anywhere community managers add recommendations using Community Builder in communities using the Summer ’15 or later version of the Napili template. Use these channel values; you can’t rename or create other channels.	Optional for creating a scheduled recommendation If not specified, defaults to `DefaultChannel`. Don’t use when updating a scheduled recommendation	36.0
`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
`recommendationAudienceId`	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
`recommendationDefinitionId`	String	ID of the recommendation definition that this scheduled recommendation schedules.	Required to create a scheduled recommendation You can’t specify a `recommendationDefinitionId` 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