Connect REST API Developer Guide

Connect REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Request Bodies
Action Link Definition Input
Action Link Group Definition Input
Action Link Input
Action Link Template Binding Input
Activity Reminder Input
Address Input
Adjust Item Input
Adjust Order Item Summary Input
Alternative Input
Announcement Input
Article Topic Assignment Job Input
Asset Action Input
Asset Action Source Input
Asset File Input
Asset State Period Input
Assigned Resource Input
Associated Actions Capability Input
Async Query Input
Audience Criterion Input
Audience Criterion Value Input
Audience Input
Available Territory Slots Input
Authorization API Payment Method Input
Authorization Reversal Input
Authorization Input
Banner Photo Input
Batch Collection Input
Batch Input
Bookmarks Capability Input
Cancel Asset Input
Canvas Capability Input
Capture Input
Card Payment Method Input
Cart Input
Cart Item Input
Cart Messages Visibility Input
Cart to Wishlist Input
Change Asset Input
Change Input
Change Item Input
Chatter Stream Input
Clean Input
Close Capability Input
Comment Capabilities Input
Comment Input
Community Input
Connectors Call Input
Connectors Call List Input
Content Capability Input
Conversation Entries Update Input
Conversation Entry Update Input
Create Credit Memo Input
Create Order Payment Summary Input
Custom List Audience Criteria Input
Custom Recommendation Audience Input
Custom Recommendation Definition Input
Datacloud Contact Import Input
Datacloud Order Input
Dashboard Component Snapshot Input
Digest Job Input
Direct Message Capability Input
Distinct Value Refinement Input
Duplicate Job Input
Duplicate Job Status Input
Ensure Funds Async Input
Ensure Refunds Async Input
Environment Hub SSO User Mapping Input
Extended Fields Input
Extension Input
Extensions Capability Input
Facetable Attribute Input
Facetable Attributes Collection Input
Feed Element Capabilities Input
Feed Entity Share Capability Input
Feed Favorite Input
Feed Item Input
Feed Item Topic Input
File ID Input
File Input
File Shares Input
Files Capability Input
Files Connect Field Value Input
Files Connect Item Input
Files Connect Permission Collection Input
Files Connect Permission Input
Find Routes With Fewest Splits Input
Folder Input
Folder Item Input
Following Input
Fulfillment Group Input
Fulfillment Order Input
Fulfillment Order Invoice Input
Fulfillment Order Line Item Input
Fulfillment Order Line Items To Cancel Input
Generate Asset Input
Generic Batch Collection Input
Generic Batch Input
Group Chatter Settings Input
Group Information Input
Group Input
Group Member Input
Group Membership Request Update
Group Record Input
Invite Collection Input
Knowledge Article View Stat Input
Lead Input
Link Capability Input
List Current Share Collection Input
Location Availability Input
Location Input
Managed Content Type Searchable Input
Managed Social Account Setup Input
Managed Topic Input
Managed Topic Position Collection Input
Managed Topic Position Input
Message Body Input
Message Segment Input: Entity Link
Message Segment Input: Hash Tag
Message Segment Input: Inline Image
Message Segment Input: Link
Message Segment Input: Markup Begin
Message Segment Input: Markup End
Message Segment Input: Mention
Message Segment Input: Text
Messaging Channel Input
Moderation Flag Input
Multiple Fulfillment Order Input
Mute Capability Input
New User Audience Criteria Input
Next Best Action Strategy Input
Notification App Setting Input
Notification Collection Input
Notification Input
Notification Member Input
Notification Setting Input
OCI Create Reservation Input
OCI Create Reservation Single Input
OCI Fulfill Reservation Input
OCI Fulfill Reservation Single Input
OCI Get Inventory Availability Input
OCI Release Reservation Input
OCI Release Reservation Single Input
OCI Transfer Reservation Input
OCI Transfer Reservation Single Input
Order Item Summary Input
Order Summary Input
Payment Group Input
Payment Method Input
Payment Method Tokenization Input
Photo Input
Pin Capability Input
Poll Capability Input
Pricing Input
Pricing Line Item Input
Product Search Grouping Input (Pilot)
Product Search Input
Push Notification Input
Quantity With Sku Input
Question and Answers Capability Input
Rank Average Distance Input
Read By Capability Input
Recommendation Reaction Input
Record Capability Input
Referenced Refund Input
Request Header Input
Scheduled Custom Recommendation Input
Searchable Attribute Input
Searchable Attributes Collection Input
Search Product Setting Collection Input
Search Product Setting Input
Service Appointment Input
Service Appointments Input
Service Appointment Update Input
Share Captured Activity Input
Share Input
Shifts from Pattern Input
Skill Requirement Input
Social Customer Service Configuration Input
Social Customer Service Message Type Settings Input
Social Customer Service Provider Settings Input
Social Post Mass Approval Input
Status Capability Input
Stream Subscription Input
Survey Email Input
Survey Recipient Engagement Context Input
Survey Recipient Survey Subjects Input
Target Collection Input
Target Collection Update Input
Target Input
Target Location Input
Target Update Input
Topic Assignment Input
Topic Endorsement Input
Topic Input
Topic Names Input
Topics Capability Input
Up Down Vote Capability Input
User Chatter Settings Input
User ID Collection Input
User Input
User Message
User Message Recipient Input
User Message Recipient List Input
User Mission Activity Input
User Status Input
User Stream (Conversation) Input
Verified Capability Input
Wishlist Input
Wishlist Item Input
Wishlist Update Input
Work Type Input
Response Bodies
Appendices
PDF

Newer Version Available

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

Scheduled Custom Recommendation Input

A scheduled custom recommendation.
Root XML tag
<scheduledRecommendation>
JSON example for creating a new scheduled custom recommendation
JSON example for updating a scheduled custom recommendation
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
Ranking scheduled custom recommendations example

If you have these scheduled custom recommendations:

Scheduled Recommendations Rank
ScheduledRecommendationA 1
ScheduledRecommendationB 2
ScheduledRecommendationC 3

And you include this information in the Scheduled Custom Recommendation Input:

Scheduled Recommendation Rank
ScheduledRecommendationD 2

The result is:

Scheduled Recommendation Rank
ScheduledRecommendationA 1
ScheduledRecommendationD 2
ScheduledRecommendationB 3
ScheduledRecommendationC 4