Use the Next Best Action REST API to execute a strategy and retrieve recommendation reactions
Quick guide on how to use the NBA REST API.
Executing an NBA Strategy for a Given Record
Official documentation: https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_nba_recommendations.htm
Example:
POST
/services/data/v45.0/connect/recommendation-strategies/Jasmine_Yogurt_Service/recommendations
Body:
{
"contextRecordId" : "5001U000006XEpjQAG",
"maxResults" : 4,
"strategyContext":{}
}
Response:
Raw Response (in JSON):
{
"executionId":"23e8f474-6fec-4b5d-b2b5-667ef7ffb03a",
"onBehalfOfId":"5001U000006XEpj",
"recommendations":[
{
"acceptanceLabel":"Add Hot Waffle Press",
"description":"Add a new Stanley Waffle Cone Press",
"imageUrl":"https://isnba--c.documentforce.com/file-asset-public/WaffleMaker1?oid=00D1U0000012w03&v=1",
"rejectionLabel":"No Thanks",
"target":{
"id":"0pr1U00000057IYQAY",
"name":"Add a Hot Waffle Press",
"type":"Recommendation",
"url":"/services/data/v45.0/connect/recommendations/0pr1U00000057IY"
},
"targetAction":{
"id":"3001U000000oZixQAE",
"name":"Dispatch_Field_Technician",
"parameters":[
],
"type":"Flow"
}
},
{
"acceptanceLabel":"Upgrade to an X120 Soft Serve",
"description":"Upgrade to a Twenty Gallon Single Nozzle Soft Serve Machine",
"imageUrl":"https://isnba--c.documentforce.com/file-asset-public/SoftServeMaker1?oid=00D1U0000012w03&v=1",
"rejectionLabel":"No Thanks",
"target":{
"id":"0pr1U00000057IXQAY",
"name":"Upgrade to an X120 Soft Serve",
"type":"Recommendation",
"url":"/services/data/v45.0/connect/recommendations/0pr1U00000057IX"
},
"targetAction":{
"id":"3001U000000oZixQAE",
"name":"Dispatch_Field_Technician",
"parameters":[
],
"type":"Flow"
}
},
{
"acceptanceLabel":"Offer refinance",
"description":"0% Refinancing on existing equipment",
"imageUrl":"https://isnba--c.documentforce.com/file-asset-public/refinance?oid=00D1U0000012w03&v=1",
"rejectionLabel":"No Thanks",
"target":{
"id":"0pr1U00000057IZQAY",
"name":"0% Refinancing!",
"type":"Recommendation",
"url":"/services/data/v45.0/connect/recommendations/0pr1U00000057IZ"
},
"targetAction":{
"id":"3001U000000oZixQAE",
"name":"Dispatch_Field_Technician",
"parameters":[
],
"type":"Flow"
}
}
],
"trace":{
"messages":[
],
"nodes":[
]
}
}
Retrieving Recommendation Reactions
Official documentation– https://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_nba_reactions.htm#connect_resources_nba_reactions
Example:
GET
/services/data/v45.0/connect/recommendation-strategies/reactions?targetId=0pr1U00000057IUQAY
This will return back all of the recommendations reactions for the recommendation with ID 0pr1U00000057IUQAY.
Similarly you can also query for the contextRecordId (e.g. Case with ID 5001U000006XEpjQAG, account, etc.)
GET
/services/data/v45.0/connect/recommendation-strategies/reactions/?contextRecordId=5001U000006XEpjQAG
RAW RESPONSE:
{
"currentPageUrl":"/services/data/v45.0/connect/recommendation-strategies/reactions?page=0&pageSize=100",
"nextPageUrl":"/services/data/v45.0/connect/recommendation-strategies/reactions?page=1&pageSize=100",
"reactions":[
{
"contextRecord":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"createdBy":{
"id":"0051U000004fPpPQAU",
"url":"/services/data/v45.0/chatter/users/0051U000004fPpPQAU"
},
"createdDate":"2019-02-28T19:13:43.000Z",
"id":"0ps1U000000TNzxQAG",
"onBehalfOf":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"reactionType":"Accepted",
"strategy":{
"id":"0sg1U0000004edzQAA",
"nameAtSnapshot":"Jasmine_Yogurt_Service"
},
"targetAction":{
"id":"3001U000000oZixQAE",
"nameAtSnapshot":"Dispatch_Field_Technician"
},
"targetRecord":{
"id":"0pr1U00000057IUQAY",
"url":"/services/data/v45.0/connect/recommendations/0pr1U00000057IUQAY"
},
"url":"/services/data/v45.0/connect/recommendation-strategies/reactions/0ps1U000000TNzxQAG"
},
{
"contextRecord":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"createdBy":{
"id":"0051U000004fPpPQAU",
"url":"/services/data/v45.0/chatter/users/0051U000004fPpPQAU"
},
"createdDate":"2019-02-28T19:13:43.000Z",
"id":"0ps1U000000TNzyQAG",
"onBehalfOf":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"reactionType":"Accepted",
"strategy":{
"id":"0sg1U0000004edzQAA",
"nameAtSnapshot":"Jasmine_Yogurt_Service"
},
"targetAction":{
"id":"3001U000000oZixQAE",
"nameAtSnapshot":"Dispatch_Field_Technician"
},
"targetRecord":{
"id":"0pr1U00000057IUQAY",
"url":"/services/data/v45.0/connect/recommendations/0pr1U00000057IUQAY"
},
"url":"/services/data/v45.0/connect/recommendation-strategies/reactions/0ps1U000000TNzyQAG"
},
{
"contextRecord":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"createdBy":{
"id":"0051U000004fPpPQAU",
"url":"/services/data/v45.0/chatter/users/0051U000004fPpPQAU"
},
"createdDate":"2019-02-28T19:13:43.000Z",
"id":"0ps1U000000TNzzQAG",
"onBehalfOf":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"reactionType":"Accepted",
"strategy":{
"id":"0sg1U0000004edzQAA",
"nameAtSnapshot":"Jasmine_Yogurt_Service"
},
"targetAction":{
"id":"3001U000000oZixQAE",
"nameAtSnapshot":"Dispatch_Field_Technician"
},
"targetRecord":{
"id":"0pr1U00000057IUQAY",
"url":"/services/data/v45.0/connect/recommendations/0pr1U00000057IUQAY"
},
"url":"/services/data/v45.0/connect/recommendation-strategies/reactions/0ps1U000000TNzzQAG"
},
{
"contextRecord":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"createdBy":{
"id":"0051U000004fPpPQAU",
"url":"/services/data/v45.0/chatter/users/0051U000004fPpPQAU"
},
"createdDate":"2019-02-28T19:13:43.000Z",
"id":"0ps1U000000TO00QAG",
"onBehalfOf":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"reactionType":"Accepted",
"strategy":{
"id":"0sg1U0000004edzQAA",
"nameAtSnapshot":"Jasmine_Yogurt_Service"
},
"targetAction":{
"id":"3001U000000oZixQAE",
"nameAtSnapshot":"Dispatch_Field_Technician"
},
"targetRecord":{
"id":"0pr1U00000057IUQAY",
"url":"/services/data/v45.0/connect/recommendations/0pr1U00000057IUQAY"
},
"url":"/services/data/v45.0/connect/recommendation-strategies/reactions/0ps1U000000TO00QAG"
},
{
"contextRecord":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"createdBy":{
"id":"0051U000004fPpPQAU",
"url":"/services/data/v45.0/chatter/users/0051U000004fPpPQAU"
},
"createdDate":"2019-03-07T05:11:29.000Z",
"id":"0ps1U000000TQzqQAG",
"onBehalfOf":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"reactionType":"Accepted",
"strategy":{
"id":"0sg1U0000004edzQAA",
"nameAtSnapshot":"Jasmine_Yogurt_Service"
},
"targetAction":{
"id":"3001U000000oZixQAE",
"nameAtSnapshot":"Dispatch_Field_Technician"
},
"targetRecord":{
"id":"0pr1U00000057IUQAY",
"url":"/services/data/v45.0/connect/recommendations/0pr1U00000057IUQAY"
},
"url":"/services/data/v45.0/connect/recommendation-strategies/reactions/0ps1U000000TQzqQAG"
},
{
"contextRecord":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"createdBy":{
"id":"0051U000004fPpPQAU",
"url":"/services/data/v45.0/chatter/users/0051U000004fPpPQAU"
},
"createdDate":"2019-03-18T18:21:15.000Z",
"id":"0ps1U000000TYoYQAW",
"onBehalfOf":{
"id":"5001U000006XEpjQAG",
"url":"/services/data/v45.0/chatter/records/5001U000006XEpjQAG"
},
"reactionType":"Accepted",
"strategy":{
"id":"0sg1U0000004edzQAA",
"nameAtSnapshot":"Jasmine_Yogurt_Service"
},
"targetAction":{
"id":"3001U000000oZixQAE",
"nameAtSnapshot":"Dispatch_Field_Technician"
},
"targetRecord":{
"id":"0pr1U00000057IUQAY",
"url":"/services/data/v45.0/connect/recommendations/0pr1U00000057IUQAY"
},
"url":"/services/data/v45.0/connect/recommendation-strategies/reactions/0ps1U000000TYoYQAW"
}
]
}























