Newer Version Available

This content describes an older version of this product. View Latest

Engagement Interactions (POST)

Create engagement interaction, engagement attendee, and engagement topic records.
Resource
1/connect/service-excellence/engagement-interactions
Resource Example
1https://yourInstance.salesforce.com/services/data/v63.0/connect/service-excellence/engagement-interactions
Available version
55.0
Requires Chatter
No
HTTP methods
POST
Request body for POST
Root XML tag
<engagementContainer>
JSON example
1{
2  "engagementInteraction": {
3    "initiatingAttendeeId": "testattendeeid",
4    "attendeeAuthenticated": true,
5    "attendeeVerified": true,
6    "startDateTime": "2022-04-17T12:00:00.000Z",
7    "endDateTime": "2022-04-17T12:04:00.000Z",
8    "communicationChannel": "Voice Call",
9    "sentiment": "Positive",
10    "contextId": "testcontextid",
11    "externalIdentifierId": "external_identifier_id",
12    "type": "Inbound",
13    "mappedState": "New",
14    "status": "New",
15    "attendeeVerificationTime": "2022-04-17T12:02:00.000Z",
16    "reason": "Unknown Charges",
17    "phoneNumber": "9999999999",
18    "customFieldsList": [
19      {
20        "key": "sampleLocation__c",
21        "value": {
22          "latitude": 12,
23          "longitude": 17
24        }
25      },
26      {
27        "key": "sampleCheckbox__c",
28        "value": "true"
29      },
30      {
31        "key": "sampleDate__c",
32        "value": "06/17/2022"
33      },
34      {
35        "key": "sampleDateTime__c",
36        "value": "2022-04-17T12:00:00.000Z"
37      },
38      {
39        "key": "sampleEmail__c",
40        "value": "sample@email.com"
41      },
42      {
43        "key": "samplePercentage__c",
44        "value": 17
45      },
46      {
47        "key": "samplePicklist__c",
48        "value": "pick1"
49      }
50    ],
51    "engagementAttendees": [
52      {
53        "startDateTime": "2022-04-17T12:00:00.000Z",
54        "endDateTime": "2022-04-17T12:04:00.000Z",
55        "externalAttendeeId": "testattendeeid",
56        "internalAttendeeId": "INTERNAL_ATTENDEE_ID",
57        "role": "Self",
58        "verificationTime": "2022-04-17T12:02:00.000Z",
59        "isAuthenticated": true,
60        "isVerified": true,
61        "customFieldsList": [
62          {
63            "key": "sampleCheckBox__c",
64            "value": true
65          },
66          {
67            "key": "sampleDateTime__c",
68            "value": "2022-04-17T12:00:00.000Z"
69          },
70          {
71            "key": "sampleEmail__c",
72            "value": "sample@email.com"
73          },
74          {
75            "key": "sampleLocation__c",
76            "value": {
77              "latitude": 12,
78              "longitude": 17
79            }
80          }
81        ]
82      }
83    ],
84    "engagementTopics": [
85      {
86        "topicId": "testtopicid",
87        "relatedPersonId": "testrelatedpersonid",
88        "name": "fee reversal",
89        "parentTopicId": "testparenttopicid",
90        "processName": "Card Fee Reversal",
91        "processType": "Flow",
92        "processStatus": "Completed",
93        "interactionSummary": "Summary",
94        "processFailureReason": "unknown",
95        "customFieldsList": [
96          {
97            "key": "sampleCheckbox__c",
98            "value": true
99          },
100          {
101            "key": "sampleDate__c",
102            "value": "06/17/2022"
103          },
104          {
105            "key": "sampleDateTime__c",
106            "value": "2022-04-17T12:00:00.000Z"
107          },
108          {
109            "key": "sampleEmail__c",
110            "value": "sample@email.com"
111          },
112          {
113            "key": "sampleLocation__c",
114            "value": {
115              "latitude": 12,
116              "longitude": 17
117            }
118          },
119          {
120            "key": "sampleNumber__c",
121            "value": 1706
122          },
123          {
124            "key": "samplePercentage__c",
125            "value": 17
126          },
127          {
128            "key": "samplePhoneNumber__c",
129            "value": "1234567890"
130          }
131        ]
132      }
133    ]
134  }
135}
Properties
Name Type Description Required or Optional Available Version
engagementInteraction Engagement Interaction Create Input Create an engagement interaction record. Required 55.0
Response body for POST
Engagement Interaction Create Output