InteractionForEmail Entity Reference

Messages

Message Web API Operation SDK Assembly
Delete DELETE [org URI]/api/data/v9.0/interactionforemails(interactionforemailid)
See Delete
DeleteRequest or
Delete
RetrieveMultiple GET [org URI]/api/data/v9.0/interactionforemails
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple

Entity Properties

Property Value
CollectionSchemaName InteractionForEmails
DisplayCollectionName Interactions for Email
DisplayName Interaction for Email
EntitySetName interactionforemails
IsBPFEntity False
LogicalCollectionName interactionforemails
LogicalName interactionforemail
OwnershipType UserOwned
PrimaryIdAttribute interactionforemailid
PrimaryNameAttribute name
SchemaName InteractionForEmail

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

EmailAddress

Property Value
Description For internal use only.
DisplayName Email Interaction Component Related Text
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName emailaddress
MaxLength 1250
RequiredLevel None
Type String

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

InteractedComponentText

Property Value
Description For internal use only.
DisplayName Email Interaction Component Related Text
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName interactedcomponenttext
MaxLength 1250
RequiredLevel None
Type String

InteractionForEmailId

Property Value
Description Unique identifier for entity instances
DisplayName Interaction for Email
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName interactionforemailid
RequiredLevel SystemRequired
Type Uniqueidentifier

InteractionLocation

Property Value
Description Shows the location for an Interaction
DisplayName Location for an Interaction
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName interactionlocation
MaxLength 1250
RequiredLevel None
Type String

InteractionRepliedBy

Property Value
Description Shows the Name who replied to email if interaction is reply
DisplayName Name who replied to email if interaction is reply
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName interactionrepliedby
MaxLength 1250
RequiredLevel None
Type String

InteractionReplyId

Property Value
Description InteractionReplyId
DisplayName InteractionReplyId
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName interactionreplyid
MaxLength 1250
RequiredLevel None
Type String

InteractionUserAgent

Property Value
Description Shows the User Agent for an Interaction if available
DisplayName User Agent for an Interaction
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName interactionuseragent
MaxLength 1250
RequiredLevel None
Type String

name

Property Value
Description The name of the custom entity.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName name
MaxLength 100
RequiredLevel SystemRequired
Type String

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

OwnerId

Property Value
Description Unique identifier of the user or team who owns the record.
DisplayName Owner
IsValidForForm True
IsValidForRead True
LogicalName ownerid
RequiredLevel SystemRequired
Targets systemuser,team
Type Owner

OwnerIdType

Property Value
Description Owner Id Type
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName owneridtype
RequiredLevel SystemRequired
Type EntityName

statecode

Property Value
Description Status of the Interaction for Email
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Property Value
Description Reason for the status of the Interaction for Email
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

TransactionCurrencyId

Property Value
Description Exchange rate for the currency associated with the InteractionForEmail with respect to the base currency.
DisplayName Currency
IsValidForForm True
IsValidForRead True
LogicalName transactioncurrencyid
RequiredLevel None
Targets transactioncurrency
Type Lookup

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

EmailActivityId

Property Value
Description Email Activity Id.
DisplayName Email Activity Id
IsValidForForm False
IsValidForRead True
LogicalName emailactivityid
RequiredLevel None
Type Uniqueidentifier

EmailInteractionReplyId

Property Value
Description Email Activity Id.
DisplayName Email Activity Id
IsValidForForm False
IsValidForRead True
LogicalName emailinteractionreplyid
RequiredLevel None
Type Uniqueidentifier

EmailInteractionTime

Property Value
DateTimeBehavior UserLocal
Description Shows the Interaction date and time of the an email.
DisplayName Interaction date and time of the an email
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName emailinteractiontime
RequiredLevel None
Type DateTime

ExchangeRate

Property Value
Description Exchange rate for the currency associated with the InteractionForEmail with respect to the base currency.
DisplayName ExchangeRate
IsValidForForm True
IsValidForRead True
LogicalName exchangerate
MaxValue 100000000000
MinValue 0.0000000001
Precision 10
RequiredLevel None
Type Decimal

InteractionPartyId

Property Value
Description For internal use only.
DisplayName Interaction party id.
IsValidForForm False
IsValidForRead True
LogicalName interactionpartyid
RequiredLevel None
Type Uniqueidentifier

InteractionPartyTypecode

Property Value
Description For internal use only
DisplayName Interaction party type code.
Format None
IsValidForForm False
IsValidForRead False
LogicalName interactionpartytypecode
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

InteractionType

Property Value
Description Shows the type of Interaction.
DisplayName Interaction Type
IsValidForForm False
IsValidForRead True
LogicalName interactiontype
RequiredLevel SystemRequired
Type Picklist

InteractionType Options

Value Label
0 EmailOpen
1 LinkOpen
2 AttachmentOpen
3 EmailReply

ModifiedBy

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdName

Property Value
Description Name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridname
MaxLength 100
RequiredLevel SystemRequired
Type String

OwnerIdYomiName

Property Value
Description Yomi name of the owner
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName owneridyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

OwningBusinessUnit

Property Value
Description Unique identifier for the business unit that owns the record
DisplayName Owning Business Unit
IsValidForForm False
IsValidForRead True
LogicalName owningbusinessunit
RequiredLevel None
Targets businessunit
Type Lookup

OwningTeam

Property Value
Description Unique identifier for the team that owns the record.
DisplayName Owning Team
IsValidForForm False
IsValidForRead True
LogicalName owningteam
RequiredLevel None
Targets team
Type Lookup

OwningUser

Property Value
Description Unique identifier for the user that owns the record.
DisplayName Owning User
IsValidForForm False
IsValidForRead True
LogicalName owninguser
RequiredLevel None
Targets systemuser
Type Lookup

TransactionCurrencyIdName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName transactioncurrencyidname
MaxLength 100
RequiredLevel None
Type String

VersionNumber

Property Value
Description
DisplayName
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

interactionforemail_ActivityPointers

Same as activitypointer entity interactionforemail_ActivityPointers Many-To-One relationship.

Property Value
ReferencingEntity activitypointer
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName new_interactionforemail_ActivityPointers
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

interactionforemail_AsyncOperations

Same as asyncoperation entity interactionforemail_AsyncOperations Many-To-One relationship.

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
IsHierarchical False
IsCustomizable True
ReferencedEntityNavigationPropertyName new_interactionforemail_AsyncOperations
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order:
CascadeConfiguration Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

lk_interactionforemail_createdby

See systemuser Entity lk_interactionforemail_createdby One-To-Many relationship.

lk_interactionforemail_createdonbehalfby

See systemuser Entity lk_interactionforemail_createdonbehalfby One-To-Many relationship.

lk_interactionforemail_modifiedby

See systemuser Entity lk_interactionforemail_modifiedby One-To-Many relationship.

lk_interactionforemail_modifiedonbehalfby

See systemuser Entity lk_interactionforemail_modifiedonbehalfby One-To-Many relationship.

user_interactionforemail

See systemuser Entity user_interactionforemail One-To-Many relationship.

team_interactionforemail

See team Entity team_interactionforemail One-To-Many relationship.

business_unit_interactionforemail

See businessunit Entity business_unit_interactionforemail One-To-Many relationship.

TransactionCurrency_InteractionForEmail

See transactioncurrency Entity TransactionCurrency_InteractionForEmail One-To-Many relationship.

See also

About the Entity Reference
Web API Reference
interactionforemail EntityType