Scheduled Custom Recommendation

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

Resource

/connect/scheduled-recommendations/scheduledRecommendationId

/connect/communities/communityId/scheduled-recommendations/scheduledRecommendationId

Available version

33.0

Requires Chatter

Yes

HTTP methods

GET, PATCH, DELETE

Request body for PATCH

Root XML tag

<scheduledRecommendation>

JSON example for updating a scheduled custom recommendation

{   "rank" : "2"}

Properties

Name	Type	Description	Required or Optional	Available Version
channel	String	A way to tie custom recommendations together. For example, display recommendations in specific places in the UI or 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 Experience 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 and Partner Central Experience Builder templates. They also appear in the feed in the Salesforce mobile web and anywhere community managers add recommendations using Experience 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 custom recommendation is enabled and appears in Experience Cloud sites. If false, custom recommendations in feeds in Salesforce mobile web aren’t removed, but no new custom recommendations appear. In Customer Service and Partner Central sites, disabled custom recommendations no longer appear.	Optional	34.0
rank	Integer	Relative rank of the scheduled custom recommendation indicated by ascending whole numbers starting with 1. Setting the rank is comparable to an insertion into an ordered list. The scheduled custom recommendation is inserted into the position specified by the rank. The rank of all the scheduled custom recommendations after it is pushed down. See Ranking scheduled custom recommendations example. If the specified rank is larger than the size of the list, the scheduled custom recommendation is put at the end of the list. The rank of the scheduled custom recommendation is the size of the list, instead of the one specified. If a rank is not specified, the scheduled custom recommendation is put at the end of the list.	Optional	33.0
recommendation​AudienceId	String	ID of the audience for this scheduled custom recommendation. When updating a scheduled custom recommendation, specify ALL to remove the association between a custom recommendation audience and a scheduled custom recommendation.	Optional	35.0
recommendation​DefinitionId	String	ID of the custom recommendation definition that this scheduled recommendation schedules.	Required for creating a scheduled recommendation You can’t specify a recommendation​DefinitionId when updating a scheduled custom 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 custom recommendation is enabled and appears in Experience Cloud sites. If false, custom recommendations in feeds in Salesforce mobile web aren’t removed, but no new custom recommendations appear. In Customer Service and Partner Central sites, disabled custom recommendations no longer appear.	Optional	34.0
rank	Integer	Relative rank of the scheduled custom recommendation indicated by ascending whole numbers starting with 1. Setting the rank is comparable to an insertion into an ordered list. The scheduled custom recommendation is inserted into the position specified by the rank. The rank of all the scheduled custom recommendations after it is pushed down. See Ranking scheduled custom recommendations example. If the specified rank is larger than the size of the list, the scheduled custom recommendation is put at the end of the list. The rank of the scheduled custom recommendation is the size of the list, instead of the one specified. If a rank is not specified, the scheduled custom recommendation is put at the end of the list.	Optional	33.0
recommendation​AudienceId	String	ID of the audience for this scheduled custom recommendation. When updating a scheduled custom recommendation, specify ALL to remove the association between a custom recommendation audience and a scheduled custom recommendation.	Optional	35.0

Response body for PATCH

Scheduled Custom 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 custom recommendation of a custom recommendation definition, deletes the custom recommendation definition. Default is false.	Optional	35.0

Response for DELETE

204: Successful Delete

Deleting a scheduled custom recommendation is comparable to a deletion in an ordered list. All scheduled custom recommendations after the deleted scheduled custom recommendation receive a new, higher rank automatically.