Engagement Attendee Create Input | Industries Common Resources Developer Guide

Root XML tag

<engagementAttendee>

JSON Example

1{
2  "engagementAttendees": [
3    {
4      "startDateTime": "2022-04-17T12:00:00.000Z",
5      "endDateTime": "2022-04-17T12:04:00.000Z",
6      "externalAttendeeId": "TEST_EXTERNAL_ATTENDEE_ID",
7      "internalAttendeeId": "TEST_INTERNAL_ATTENDEE_ID",
8      "role": "Self",
9      "verificationTime": "2022-04-17T12:02:00.000Z",
10      "isAuthenticated": true,
11      "isVerified": true,
12      "customFieldsList": [
13        {
14          "key": "sampleCheckBox__c",
15          "value": true
16        },
17        {
18          "key": "sampleDateTime__c",
19          "value": "2022-04-17T12:00:00.000Z"
20        },
21        {
22          "key": "sampleEmail__c",
23          "value": "sample@email.com"
24        },
25        {
26          "key": "sampleLocation__c",
27          "value": {
28            "latitude": 12,
29            "longitude": 17
30          }
31        }
32      ]
33    }
34  ]
35}

Properties

Name	Type	Description	Required or Optional	Available Version
`customFieldsList`	Engagement Custom Fields Input[]	The custom fields and their values for engagement attendees.	Optional	56.0
`endDateTime`	String	The date and time when an engagement with an attendee ended.	Optional	55.0
`engagementInteractionId`	String	The ID of the associated engagement interaction record.	Required	55.0
`externalAttendeeId`	String	The external user related to an engagement, such as the customer or partner.	Optional	55.0
`id`	String	The ID of the engagement attendee record.	Required	55.0
`internalAttendeeId`	String	The internal user related to the engagement, such as the call center agent.	Optional	55.0
`isAuthenticated`	String	Indicates whether the initiating attendee of an engagement interaction was authenticated through IVR or Web channel (`true`) or not (`false`).	Required	55.0
`isVerified`	Boolean	Indicates whether the initiating attendee of the engagement interaction was verified (true) or not (false).	Required	55.0
`ownerId`	String	The Salesforce ID of the person who owns an engagement attendee record.	Required	55.0
`role`	String	The role of an engagement attendee.	Optional	55.0
`startDateTime`	String	The date and time when an engagement with an attendee started.	Required	55.0
`verificationTime`	String	The time when an attendee was verified for an engagement interaction.	Optional	55.0