ConnectApi.EngagementAttendeeCreateInput

Input representation to create an engagement attendee record.

PropertyTypeDescriptionRequired or OptionalAvailable Version
customFieldsListList<ConnectApi.EngagementCustomFieldsInput>The custom fields and their values for engagement attendees.Optional56.0
endDateTimeStringThe date and time when the engagement with the attendee ends.Optional55.0
engagementInteractionIdStringThe Engagement Interaction ID related to the attendee. 55.0
externalAttendeeIdStringThe external user related to the engagement, such as the customer or partner. To avoid an error, either this field or the InternalAttendeeId field must have a value. The value must be an account, contact, or lead. 55.0
idStringThe ID field for an EngagementAttendee record.Required55.0
internalAttendeeIdStringThe internal user related to the engagement, such as the call center agent. To avoid an error, either this field or the ExternalAttendeeId field must have a value. The value must be a user. 55.0
isAuthenticatedBooleanIndicates whether the initiating attendee of the engagement interaction was authenticated through interactive voice response (IVR) or Web channel (true) or not (false). The default value is false. 55.0
isVerifiedBooleanIndicates whether the initiating attendee of the engagement interaction was verified (true) or not (false). The default value is false. 55.0
ownerIdStringThe Salesforce ID of the person who owns this engagement attendee record. 55.0
roleStringThe role of an engagement attendee. The possible values are:
  • OnBehalf
  • Self
 56.0
startDateTimeStringThe date and time when the engagement with the attendee starts.Required55.0
verificationTimeStringThe time when the attendee was verified for the engagement interaction. 55.0