Scheduled Recommendation

Community managers (users with the Create and Set Up Communities or Manage Communities permission) can access, create, and delete audiences, definitions, and schedules for community recommendations. Users with the Modify All Data permission can also access, create, and delete recommendation audiences, recommendation definitions, and scheduled recommendations.

Resource

Available version

33.0

Requires Chatter

No

HTTP methods

GET, HEAD, PATCH, DELETE

Request body for PATCH

Root XML tag

<scheduledRecommendation>

JSON example for updating an existing scheduled recommendation

Properties

Name	Type	Description	Required or Optional	Available Version
channel	String	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 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. 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 Salesforce mobile web aren’t removed, but no new recommendations appear. In Customer Service (Napili) and Partner Central communities, 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 Salesforce mobile web aren’t removed, but no new recommendations appear. In Customer Service (Napili) and Partner Central communities, 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.