Next Best Action, Reactions

Get and record user reactions to recommendations.

Resource

1/connect/recommendation-strategies/reactions

Available version

45.0

HTTP methods

GET, POST

Users with the Manage Next Best Action Recommendations or Modify All Data permission can get recommendation reactions.

Request parameters for GET

Name	Type	Description	Required or Optional	Available Version
`contextRecordId`	String	Use the ID of a context record to filter the results.	Optional	45.0
`createdById`	String	Use the ID of the user who is indirectly reacting to the recommendation to filter the results.	Optional	45.0
`onBehalfOfId`	String	Use the ID of the user or record that created the recommendation reaction to filter the results.	Optional	45.0
`page`	Integer	Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.	Optional	45.0
`pageSize`	Integer	Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25.	Optional	45.0
`targetId`	String	Use the ID of the target to filter the results.	Optional	45.0

Response body for GET

Recommendation Reaction Collection

Request body for POST

Root XML tag

<reaction>

JSON example

1{
2   "contextRecordId": "500xx000000Ylnv",
3   "onBehalfOfId": "001xx000003DGQW",
4   "reactionType": "Accepted",
5   "strategyName": "AcmeSupport",
6   "targetActionName": "UpgradeService",
7   "targetId": "0prxx00000000M7AAI"
8}

Properties

Name	Type	Description	Required or Optional	Available Version
`aiModel`	String	Reserved for future use.	Optional	47.0
`contextRecordId`	String	ID of the context record. For example, if the next best action is on a case detail page, the ID of the case.	Optional	45.0
`executionId`	String	ID of the original recommendation strategy execution.	Optional	45.0
`externalId`	String	External ID of the recommendation. This ID doesn’t need to be a Salesforce 18-character ID. For example, it can be a product number from an external system.	Optional	46.0
`onBehalfOfId`	String	ID of the user or entity for which the reaction took place.	Optional	45.0
`reactionType`	String	Type of reaction to a recommendation. Values are: `Accepted` `Rejected`	Required	45.0
`recommendationMode`	String	Reserved for future use.	Optional	46.0
`recommendationScore`	Double	Reserved for future use.	Optional	46.0
`strategyName`	String	Name of the recommendation strategy.	Required	45.0
`targetActionId`	String	ID of the target action.	Optional	45.0
`targetActionName`	String	Name of the target action.	Required	45.0
`targetId`	String	ID of the recommendation that is being reacted to.	Required	45.0

Response body for POST

Recommendation Reaction

Connect REST API Developer Guide

Next Best Action, Reactions