Save Recommendation Decisions

This object is available in API version 51.0 and later for users with a Consumer Goods Cloud license.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/standard/saveRecommendationDecision

Formats: JSON, XML

HTTP Methods: GET, HEAD, POST

Authentication: Authorization: Bearer token

Inputs

Input	Type	Description
actionParams	string	Required parameters based on the action type that are relevant to process a decision.
actionType	string	Required. Decision made for a recommendation. The possible values are: `Accept` `Reject`
recommendationId	string	Unique identifier of the recommendation.

Input

Type

Description

actionParams

string

Required parameters based on the action type that are relevant to process a decision.

actionType

string

Required. Decision made for a recommendation.

The possible values are:

Accept
Reject

recommendationId

string

Unique identifier of the recommendation.

Outputs

Input	Type	Description
actionMessage	string	Details about why a recommendation is accepted or rejected.
actionStatus	string	Indicates whether a recommendation decision succeeded or failed.

Example

Sample Request

JSON Request Body

{
   "inputs": [{
      "recommendationId":"9TuB0000000TN6iKAG",
      "actionType":"Accept",
      "actionParams":{
         "TaskGenerationType":"AIVisitTaskTemplate" //For Consumer Goods Cloud
      }
   }]
}

Sample Response

JSON Response Body

{
   "actionName": "saveRecommendationDecision",
   "errors": null,
   "isSuccess": true,
   "outputValues": {
      "actionStatus": "success",
      "actionMessage": "The visit was scheduled.",
   }
}

Sample Error

JSON Error Body

[{
   "actionName": "saveRecommendationDecision",
   "errors": null,
   "isSuccess": true,
   "outputValues": {
      "actionStatus": "error",
      "actionMessage": "We can’t schedule the recommendation because the recommendation status isn’t Recommended.",
   }
}]