Newer Version Available

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

EngagementAttendee

Represents information about an attendee of an engagement. For example, when a customer initiates an engagement interaction by calling a service representative to inquire about an insurance claim, this object stores information about the customer and the service representative. This object is available in API version 55.0 and later

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Special Access Rules

The Manufacturing Cloud permission set license is required to use this object.

Fields

Field Details
EndDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The date and time when the engagement with the attendee ends.
EngagementId
Type
reference
Properties
Create, Filter, Group, Sort, Update
Description
Required. The engagement interaction or the voice call that’s related to the attendee.
This field is a relationship field.
Relationship Name
Engagement
Relationship Type
Lookup
Refers To
EngagementInteraction, VoiceCall
ExternalAttendeeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The 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.
This field is a polymorphic relationship field. A polymorphic field is one where the related object might be one of several different types of objects. For example, the Who relationship field of a Task can be a Contact or a Lead.
Relationship Name
ExternalAttendee
Relationship Type
Lookup
Refers To
Account, Contact, Lead
InternalAttendeeId
Type
reference
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
The 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.
This field is a relationship field.
Relationship Name
InternalAttendee
Relationship Type
Lookup
Refers To
User
IsAuthenticated
Type
boolean
Properties
Create, Defaulted on Create, Filter, Group, Sort, Update
Description
Indicates 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.
This field is available in API version 56.0 and later.
IsVerified
Type
boolean
Properties
Create, Defaulted on Create, Filter, Group, Sort, Update
Description
Indicates whether the initiating attendee of the engagement interaction was verified (true) or not (false). The default value is false.
This field is available in API version 56.0 and later.
Name
Type
string
Properties
Autonumber, Defaulted on create, Filter, idLookup, Sort
Description
The name of the Engagement Attendee record.
OwnerId
Type
reference
Properties
Create, Defaulted on create, Filter, Group, Sort, Update
Description
The Salesforce ID of the person who owns this engagement attendee record.
This field is a relationship field.
Relationship Name
Owner
Relationship Type
Lookup
Refers To
User
Role
Type
picklist
Properties
Create, Filter, Group, Nillable, Sort, Update
Description

The role of an engagement attendee. This field is available in API version 56.0 and later.

Possible values are:
  • OnBehalf
  • Self
StartDateTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
Required. The date and time when the engagement with the attendee starts.
VerificationTime
Type
dateTime
Properties
Create, Filter, Nillable, Sort, Update
Description
The time when the attendee was verified for the engagement interaction. This field is available in API version 56.0 and later.

Usage

This object is used in the Verify Customer Identity and the Verify Customer Identity Base Flow flow templates.

Associated Objects

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version and later.

EngagementAttendeeChangeEvent
Change events are available for the object.
EngagementAttendeeFeed
Feed tracking is available for the object.
EngagementAttendeeHistory
History is available for tracked fields of the object.