Newer Version Available

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

ConnectApi.ScheduledRecommendation

Represents a scheduled recommendation.
Property Name Type Description Available Version
channel ConnectApi.​Recommendation​Channel 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:
  • CustomChannel1Custom 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 Home and Question Detail pages of Customer Service (Napili) and Partner Central communities. They also appear in the feed in communities in the Salesforce mobile web and anywhere community managers add recommendations using Community Builder.
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 Salesforce mobile web aren’t removed, but no new recommendations appear. In Customer Service (Napili) and Partner Central communities, disabled recommendations no longer appear. 35.0
id String 18-character ID of the scheduled recommendation. 35.0
rank Integer The rank determining the order of this scheduled recommendation. 35.0
recommendation​AudienceId String ID of the audience for the scheduled recommendation. 35.0
recommendation​Definition​Representation ConnectApi.​Recommendation​Definition Recommendation definition that this scheduled recommendation schedules. 35.0
url String URL to the Chatter REST API resource for the scheduled recommendation. 35.0