Newer Version Available
Engagement Interactions (POST)
- Resource
-
1/connect/service-excellence/engagement-interactions - Resource Example
-
1https://yourInstance.salesforce.com/services/data/v56.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 "customFieldsList": [ 18 { 19 "key": "sampleLocation__c", 20 "value": { 21 "latitude": 12, 22 "longitude": 17 23 } 24 }, 25 { 26 "key": "sampleCheckbox__c", 27 "value": "true" 28 }, 29 { 30 "key": "sampleDate__c", 31 "value": "06/17/2022" 32 }, 33 { 34 "key": "sampleDateTime__c", 35 "value": "2022-04-17T12:00:00.000Z" 36 }, 37 { 38 "key": "sampleEmail__c", 39 "value": "sample@email.com" 40 }, 41 { 42 "key": "samplePercentage__c", 43 "value": 17 44 }, 45 { 46 "key": "samplePicklist__c", 47 "value": "pick1" 48 } 49 ], 50 "engagementAttendees": [ 51 { 52 "startDateTime": "2022-04-17T12:00:00.000Z", 53 "endDateTime": "2022-04-17T12:04:00.000Z", 54 "externalAttendeeId": "testattendeeid", 55 "internalAttendeeId": "INTERNAL_ATTENDEE_ID", 56 "role": "Self", 57 "verificationTime": "2022-04-17T12:02:00.000Z", 58 "isAuthenticated": true, 59 "isVerified": true, 60 "customFieldsList": [ 61 { 62 "key": "sampleCheckBox__c", 63 "value": true 64 }, 65 { 66 "key": "sampleDateTime__c", 67 "value": "2022-04-17T12:00:00.000Z" 68 }, 69 { 70 "key": "sampleEmail__c", 71 "value": "sample@email.com" 72 }, 73 { 74 "key": "sampleLocation__c", 75 "value": { 76 "latitude": 12, 77 "longitude": 17 78 } 79 } 80 ] 81 } 82 ], 83 "engagementTopics": [ 84 { 85 "topicId": "testtopicid", 86 "relatedPersonId": "testrelatedpersonid", 87 "name": "fee reversal", 88 "parentTopicId": "testparenttopicid", 89 "processName": "Card Fee Reversal", 90 "processType": "Flow", 91 "processStatus": "Completed", 92 "interactionSummary": "Summary", 93 "processFailureReason": "unknown", 94 "customFieldsList": [ 95 { 96 "key": "sampleCheckbox__c", 97 "value": true 98 }, 99 { 100 "key": "sampleDate__c", 101 "value": "06/17/2022" 102 }, 103 { 104 "key": "sampleDateTime__c", 105 "value": "2022-04-17T12:00:00.000Z" 106 }, 107 { 108 "key": "sampleEmail__c", 109 "value": "sample@email.com" 110 }, 111 { 112 "key": "sampleLocation__c", 113 "value": { 114 "latitude": 12, 115 "longitude": 17 116 } 117 }, 118 { 119 "key": "sampleNumber__c", 120 "value": 1706 121 }, 122 { 123 "key": "samplePercentage__c", 124 "value": 17 125 }, 126 { 127 "key": "samplePhoneNumber__c", 128 "value": "1234567890" 129 } 130 ] 131 } 132 ] 133 } 134} - 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