msdyn_whatsappengagementctx.md

title	description	ms.date	ms.topic	author	ms.author	search.audienceType	ms.reviewer
msdyn_whatsappengagementctx Entity Reference | MicrosoftDocs	Includes schema information and supported messages for the msdyn_whatsappengagementctx entity.	10/12/2020	reference	gandhamm	mgandham	developer	nenellim

msdyn_whatsappengagementctx Entity Reference

[!INCLUDEcc-use-with-omnichannel]

WhatsApp Engagement Context

Added by: Omnichannel – SocialChannels Solution

Messages

Message	Web API Operation	SDK Assembly
Assign	PATCH [org URI]/api/data/v9.0/msdyn_whatsappengagementctxes(msdyn_whatsappengagementctxid) Update ownerid property.	xref:Microsoft.Crm.Sdk.Messages.AssignRequest
Create	POST [org URI]/api/data/v9.0/msdyn_whatsappengagementctxes See Create	xref:Microsoft.Xrm.Sdk.Messages.CreateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Create*
Delete	DELETE [org URI]/api/data/v9.0/msdyn_whatsappengagementctxes(msdyn_whatsappengagementctxid) See Delete	xref:Microsoft.Xrm.Sdk.Messages.DeleteRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Delete*
GrantAccess		xref:Microsoft.Crm.Sdk.Messages.GrantAccessRequest
IsValidStateTransition		xref:Microsoft.Crm.Sdk.Messages.IsValidStateTransitionRequest
ModifyAccess		xref:Microsoft.Crm.Sdk.Messages.ModifyAccessRequest
Retrieve	GET [org URI]/api/data/v9.0/msdyn_whatsappengagementctxes(msdyn_whatsappengagementctxid) See Retrieve	xref:Microsoft.Xrm.Sdk.Messages.RetrieveRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Retrieve*
RetrieveMultiple	GET [org URI]/api/data/v9.0/msdyn_whatsappengagementctxes See Query Data	xref:Microsoft.Xrm.Sdk.Messages.RetrieveMultipleRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.RetrieveMultiple*
RetrievePrincipalAccess		xref:Microsoft.Crm.Sdk.Messages.RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess		xref:Microsoft.Crm.Sdk.Messages.RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess		xref:Microsoft.Crm.Sdk.Messages.RevokeAccessRequest
SetState	PATCH [org URI]/api/data/v9.0/msdyn_whatsappengagementctxes(msdyn_whatsappengagementctxid) Update statecode and statuscode properties.	xref:Microsoft.Crm.Sdk.Messages.SetStateRequest
Update	PATCH [org URI]/api/data/v9.0/msdyn_whatsappengagementctxes(msdyn_whatsappengagementctxid) See Update	xref:Microsoft.Xrm.Sdk.Messages.UpdateRequest or xref:Microsoft.Xrm.Sdk.IOrganizationService.Update*

Entity Properties

Property	Value
CollectionSchemaName	msdyn_whatsappengagementctxes
DisplayCollectionName	WhatsApp Engagement Context
DisplayName	WhatsApp Engagement Context
EntitySetName	msdyn_whatsappengagementctxes
IsBPFEntity	False
LogicalCollectionName	msdyn_whatsappengagementctxes
LogicalName	msdyn_whatsappengagementctx
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_whatsappengagementctxid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_whatsappengagementctx

Writable attributes

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

• ImportSequenceNumber
• msdyn_customerfirstmessage
• msdyn_customername
• msdyn_customerphonenumber
• msdyn_liveworkitemid
• msdyn_name
• msdyn_whatsappengagementctxId
• msdyn_whatsappengagementid
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

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

msdyn_customerfirstmessage

Added by: Omnichannel - SocialChannels Patch Solution

Property	Value
Description	WhatsApp Customer's first incoming message
DisplayName	Customer First Message
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customerfirstmessage
MaxLength	250
RequiredLevel	None
Type	String

msdyn_customername

Property	Value
Description	Full name of the customer
DisplayName	Customer Name
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customername
MaxLength	100
RequiredLevel	None
Type	String

msdyn_customerphonenumber

Property	Value
Description	Customer Phone Number
DisplayName	Customer Phone Number
FormatName	Phone
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_customerphonenumber
MaxLength	100
RequiredLevel	None
Type	String

msdyn_liveworkitemid

Property	Value
Description	Unique identifier for Conversation associated with WhatsApp Engagement Context.
DisplayName	Conversation
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_liveworkitemid
RequiredLevel	None
Targets	msdyn_ocliveworkitem
Type	Lookup

msdyn_name

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

msdyn_whatsappengagementctxId

Property	Value
Description	Unique identifier for entity instances
DisplayName	WhatsApp Engagement Context
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_whatsappengagementctxid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_whatsappengagementid

Property	Value
Description	WhatsApp Engagement Id
DisplayName	WhatsApp Engagement Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_whatsappengagementid
MaxLength	100
RequiredLevel	None
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

Added by: Active Solution Solution

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	ownerid
RequiredLevel	SystemRequired
Targets	systemuser,team
Type	Owner

OwnerIdType

Added by: Active Solution Solution

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

statecode

Property	Value
Description	Status of the WhatsApp Engagement Context
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 WhatsApp Engagement Context
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

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
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• msdyn_liveworkitemidName
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• VersionNumber

CreatedBy

Added by: Active Solution Solution

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

Added by: Active Solution Solution

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

CreatedByYomiName

Added by: Active Solution Solution

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

Added by: Active Solution Solution

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

Added by: Active Solution Solution

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

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

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

ModifiedBy

Added by: Active Solution Solution

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

Added by: Active Solution Solution

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

ModifiedByYomiName

Added by: Active Solution Solution

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

Added by: Active Solution Solution

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

Added by: Active Solution Solution

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

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

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

msdyn_liveworkitemidName

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

OwnerIdName

Added by: Active Solution Solution

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

Added by: Active Solution Solution

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

Added by: Active Solution Solution

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

Added by: Active Solution Solution

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

Added by: Active Solution Solution

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

VersionNumber

Added by: Active Solution Solution

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

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_msdyn_whatsappengagementctx_createdby
• lk_msdyn_whatsappengagementctx_createdonbehalfby
• lk_msdyn_whatsappengagementctx_modifiedby
• lk_msdyn_whatsappengagementctx_modifiedonbehalfby
• user_msdyn_whatsappengagementctx

lk_msdyn_whatsappengagementctx_createdby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_whatsappengagementctx_createdby One-To-Many relationship.

lk_msdyn_whatsappengagementctx_createdonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_whatsappengagementctx_createdonbehalfby One-To-Many relationship.

lk_msdyn_whatsappengagementctx_modifiedby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_whatsappengagementctx_modifiedby One-To-Many relationship.

lk_msdyn_whatsappengagementctx_modifiedonbehalfby

Added by: System Solution Solution

See systemuser Entity lk_msdyn_whatsappengagementctx_modifiedonbehalfby One-To-Many relationship.

user_msdyn_whatsappengagementctx

Added by: System Solution Solution

See systemuser Entity user_msdyn_whatsappengagementctx One-To-Many relationship.

See also

Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service

[!INCLUDEfooter-include]