Custom Recommendation Definition
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/recommendation-definitions/recommendationDefinitionId
/connect/communities/communityId/recommendation-definitions/recommendationDefinitionId
- Available version
- 33.0
- Requires Chatter
- Yes
- HTTP methods
- GET, PATCH, DELETE
- Request body for PATCH
-
- JSON example
-
{ "actionUrl" : "https://www.example.com", "actionUrlName" : "Launch", "explanation" : "Click this link to learn more!", "name" : "Corporate Training Project", "title" : "Want to learn more about Corporate Training Project?"}
- Properties
-
Name Type Description Required or Optional Available Version actionUrl String URL for acting on the custom recommendation, for example, the URL to join a group. Optional 33.0 actionUrlName String Text label for the action URL in the user interface, for example, “Launch.” Optional 34.0 explanation String Explanation, or body, of the custom recommendation. Optional 33.0 name String Name of the custom recommendation definition. The name is displayed in Setup. Optional 33.0 title String Title of the custom recommendation definition. Optional 33.0
- Request parameters for PATCH
-
Parameter Name Type Description Required or Optional Available Version actionUrl String URL for acting on the custom recommendation, for example, the URL to join a group. Optional 33.0 actionUrlName String Text label for the action URL in the user interface, for example, “Launch.” Optional 34.0 explanation String Explanation, or body, of the custom recommendation. Optional 33.0 name String Name of the custom recommendation definition. The name is displayed in Setup. Optional 33.0 title String Title of the custom recommendation definition. Optional 33.0 - Response body for GET and PATCH
- Custom Recommendation Definition
- Response for DELETE
- 204: Successful Delete