Recommendation Definition

Only community managers (users with the “Create and Set Up Communities” or “Manage Communities” permission) and users with the “Modify All Data” permission can access and create custom recommendations. These recommendations are available only in feeds in communities using the Napili or Salesforce Tabs + Visualforce template in Salesforce1 and via Chatter REST API.

Resource

1/connect/recommendation-definitions/${recommendationDefinitionId}

1/connect/communities/communityId/recommendation-definitions/recommendationDefinitionId

Available version

33.0

Requires Chatter

No

HTTP methods

GET, HEAD, PATCH, DELETE

Request body for PATCH

JSON example

1{ 
2   "actionUrl" : "https://www.example.com",
3   "explanation" : "Click this link to learn more!",
4   "name" : "Corporate Training Project",
5   "title" : "Want to learn more about Corporate Training Project?"}

Properties

Name	Type	Description	Required or Optional	Available Version
actionUrl	String	The URL for acting on the recommendation, for example, the URL to join a group.	Required for creating a new recommendation definition. Optional for updating an existing recommendation definition.	33.0
explanation	String	The explanation, or body, of the recommendation.	Required for creating a new recommendation definition. Optional for updating an existing recommendation definition.	33.0
name	String	The name of the recommendation definition. The name is displayed in Setup.	Required for creating a new recommendation definition. Optional for updating an existing recommendation definition.	33.0
title	String	The title of the recommendation definition.	Optional	33.0

Request parameters for PATCH

Parameter Name	Type	Description	Required or Optional	Available Version
actionUrl	String	The URL for acting on the recommendation, for example, the URL to join a group.	Optional	33.0
explanation	String	The explanation, or body, of the recommendation.	Optional	33.0
name	String	The name of the recommendation definition. The name is displayed in Setup.	Optional	33.0
title	String	The title of the recommendation definition.	Optional	33.0

Response body for GET and PATCH

Recommendation Definition

Response for DELETE

204: Successful Delete