WhatsApp account (msdyn_ocwhatsappchannelaccount) table/entity reference (Microsoft Dynamics 365 Field Service)

WhatsApp accounts for Omnichannel integration

Messages

The following table lists the messages for the WhatsApp account (msdyn_ocwhatsappchannelaccount) table. Messages represent operations that can be performed on the table. They may also be events.

Name Is Event?	Web API Operation	SDK for .NET
Assign Event: True	PATCH /msdyn_ocwhatsappchannelaccounts(msdyn_ocwhatsappchannelaccountid) Update the ownerid property.	AssignRequest
Associate Event: True	Associate records	Associate records
BulkRetain Event: True	BulkRetain	Learn to use messages with the SDK for .NET
Create Event: True	POST /msdyn_ocwhatsappchannelaccounts See Create	Create records
CreateMultiple Event: True	CreateMultiple	CreateMultipleRequest
Delete Event: True	DELETE /msdyn_ocwhatsappchannelaccounts(msdyn_ocwhatsappchannelaccountid) See Delete	Delete records
Disassociate Event: True	Disassociate records	Disassociate records
GrantAccess Event: True	GrantAccess	GrantAccessRequest
IsValidStateTransition Event: False	IsValidStateTransition	IsValidStateTransitionRequest
ModifyAccess Event: True	ModifyAccess	ModifyAccessRequest
PurgeRetainedContent Event: True	PurgeRetainedContent	Learn to use messages with the SDK for .NET
Restore Event: True	Restore	Learn to use messages with the SDK for .NET
Retain Event: True	Retain	Learn to use messages with the SDK for .NET
Retrieve Event: True	GET /msdyn_ocwhatsappchannelaccounts(msdyn_ocwhatsappchannelaccountid) See Retrieve	Retrieve records
RetrieveMultiple Event: True	GET /msdyn_ocwhatsappchannelaccounts See Query data	Query data
RetrievePrincipalAccess Event: True	RetrievePrincipalAccess	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess Event: True	RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess Event: True	RevokeAccess	RevokeAccessRequest
RollbackRetain Event: True	RollbackRetain	Learn to use messages with the SDK for .NET
SetState Event: True	PATCH /msdyn_ocwhatsappchannelaccounts(msdyn_ocwhatsappchannelaccountid) Update the statecode and statuscode properties.	SetStateRequest
Update Event: True	PATCH /msdyn_ocwhatsappchannelaccounts(msdyn_ocwhatsappchannelaccountid) See Update	Update records
UpdateMultiple Event: True	UpdateMultiple	UpdateMultipleRequest
Upsert Event: False	PATCH /msdyn_ocwhatsappchannelaccounts(msdyn_ocwhatsappchannelaccountid) See Upsert a table row	UpsertRequest
UpsertMultiple Event: False	UpsertMultiple	UpsertMultipleRequest
ValidateRetentionConfig Event: True	ValidateRetentionConfig	Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the WhatsApp account (msdyn_ocwhatsappchannelaccount) table.

Property	Value
DisplayName	WhatsApp account
DisplayCollectionName	WhatsApp accounts
SchemaName	msdyn_ocwhatsappchannelaccount
CollectionSchemaName	msdyn_ocwhatsappchannelaccounts
EntitySetName	msdyn_ocwhatsappchannelaccounts
LogicalName	msdyn_ocwhatsappchannelaccount
LogicalCollectionName	msdyn_ocwhatsappchannelaccounts
PrimaryIdAttribute	msdyn_ocwhatsappchannelaccountid
PrimaryNameAttribute	msdyn_name
TableType	Standard
OwnershipType	UserOwned

Writable columns/attributes

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

• ImportSequenceNumber
• IsCustomizable
• msdyn_authenticationtoken
• msdyn_name
• msdyn_ocwhatsappchannelaccountId
• msdyn_provideraccountid
• msdyn_ProviderAcsConnectionStringId
• msdyn_ProviderAcsResourceName
• msdyn_ProviderEventGridAppId
• msdyn_ProviderEventGridAppTenantId
• msdyn_ProviderType
• msdyn_secureauthenticationtoken
• msdyn_TwilioInboundURL
• msdyn_WabaReviewStatus
• msdyn_WabaSharingStatus
• msdyn_WhatsAppBillingId
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

ImportSequenceNumber

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

IsCustomizable

Property	Value
Description	For internal use only.
DisplayName	Is Customizable
IsValidForForm	False
IsValidForRead	True
LogicalName	iscustomizable
RequiredLevel	SystemRequired
Type	ManagedProperty

msdyn_authenticationtoken

Property	Value
Description	Authentication token of WhatsApp account.
DisplayName	Auth token
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_authenticationtoken
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	255

msdyn_name

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

msdyn_ocwhatsappchannelaccountId

Property	Value
Description	Unique identifier for entity instances
DisplayName	WhatsApp Account
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_ocwhatsappchannelaccountid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_provideraccountid

Property	Value
Description	The account ID of 3rd party provider
DisplayName	Account SID
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_provideraccountid
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	255

msdyn_ProviderAcsConnectionStringId

Property	Value
Description	Provider Azure Communication Services Connection String Reference
DisplayName	Provider Azure Communication Services Connection String Reference
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_provideracsconnectionstringid
RequiredLevel	None
Type	Lookup
Targets	msdyn_channelinstancesecret

msdyn_ProviderAcsResourceName

Property	Value
Description	Provider Azure Communication Services resource name
DisplayName	Provider Azure Communication Services resource name
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_provideracsresourcename
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	500

msdyn_ProviderEventGridAppId

Property	Value
Description	Provider Event Grid App Id
DisplayName	Provider Event Grid App Id
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providereventgridappid
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	500

msdyn_ProviderEventGridAppTenantId

Property	Value
Description	Provider Event Grid Tenant Id
DisplayName	Provider Event Grid Tenant Id
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providereventgridapptenantid
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	500

msdyn_ProviderType

Property	Value
Description	Channel Provider for Whatsapp Channel
DisplayName	Channel Provider
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providertype
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	192350000
GlobalChoiceName	msdyn_ocwhatsappchannelaccount_msdyn_providertype

msdyn_ProviderType Choices/Options

Value	Label
192350000	Twilio
192350001	Azure Communication Services
192350002	Meta

msdyn_secureauthenticationtoken

Property	Value
Description	OC Authentication token of WhatsApp account.
DisplayName	OC Auth token
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_secureauthenticationtoken
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	255

msdyn_TwilioInboundURL

Property	Value
Description	URL for Twilio inbound request
DisplayName	Twilio inbound URL
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_twilioinboundurl
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	500

msdyn_WabaReviewStatus

Property	Value
Description	Meta review status for the WhatsApp Business Account
DisplayName	WABA review status
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_wabareviewstatus
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	msdyn_ocwhatsappchannelaccount_msdyn_wabareviewstatus

msdyn_WabaReviewStatus Choices/Options

Value	Label
192350000	Approved
192350001	Pending
192350002	Rejected

msdyn_WabaSharingStatus

Property	Value
Description	Meta WABA sharing status, written by WhatsApp Manager during registration
DisplayName	WABA sharing status
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_wabasharingstatus
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	msdyn_ocwhatsappchannelaccount_msdyn_wabasharingstatus

msdyn_WabaSharingStatus Choices/Options

Value	Label
192350000	Shared
192350001	Not Shared

msdyn_WhatsAppBillingId

Property	Value
Description	Meta billing/allocation config ID (allocation_config_id), written by WhatsApp Manager during registration
DisplayName	WhatsApp Billing ID
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_whatsappbillingid
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

OverriddenCreatedOn

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

OwnerId

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

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 WhatsApp Channel Account
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	msdyn_ocwhatsappchannelaccount_statecode

statecode Choices/Options

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

statuscode

Property	Value
Description	Reason for the status of the WhatsApp Channel Account
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	msdyn_ocwhatsappchannelaccount_statuscode

statuscode Choices/Options

Value	Details
1	Label: Active State:0 TransitionData: None
2	Label: Inactive State:1 TransitionData: None

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

• ComponentIdUnique
• ComponentState
• CreatedBy
• CreatedOn
• CreatedOnBehalfBy
• IsManaged
• ModifiedBy
• ModifiedOn
• ModifiedOnBehalfBy
• OverwriteTime
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningTeam
• OwningUser
• SolutionId
• SupportingSolutionId
• VersionNumber

ComponentIdUnique

Property	Value
Description	For internal use only.
DisplayName	Row id unique
IsValidForForm	False
IsValidForRead	True
LogicalName	componentidunique
RequiredLevel	SystemRequired
Type	Uniqueidentifier

ComponentState

Property	Value
Description	For internal use only.
DisplayName	Component State
IsValidForForm	False
IsValidForRead	True
LogicalName	componentstate
RequiredLevel	SystemRequired
Type	Picklist
DefaultFormValue
GlobalChoiceName	componentstate

ComponentState Choices/Options

Value	Label
0	Published
1	Unpublished
2	Deleted
3	Deleted Unpublished

CreatedBy

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

CreatedOn

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

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
Type	Lookup
Targets	systemuser

IsManaged

Property	Value
Description	Indicates whether the solution component is part of a managed solution.
DisplayName	Is Managed
IsValidForForm	False
IsValidForRead	True
LogicalName	ismanaged
RequiredLevel	SystemRequired
Type	Boolean
GlobalChoiceName	ismanaged
DefaultValue	False
True Label	Managed
False Label	Unmanaged

ModifiedBy

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

ModifiedOn

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

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
Type	Lookup
Targets	systemuser

OverwriteTime

Property	Value
Description	For internal use only.
DisplayName	Record Overwrite Time
IsValidForForm	False
IsValidForRead	True
LogicalName	overwritetime
RequiredLevel	SystemRequired
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	UserLocal
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

OwnerIdName

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

OwnerIdYomiName

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

OwningBusinessUnit

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

OwningTeam

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

OwningUser

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

SolutionId

Property	Value
Description	Unique identifier of the associated solution.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	True
LogicalName	solutionid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

SupportingSolutionId

Property	Value
Description	For internal use only.
DisplayName	Solution
IsValidForForm	False
IsValidForRead	False
LogicalName	supportingsolutionid
RequiredLevel	None
Type	Uniqueidentifier

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

msdyn_msdyn_channelinstancesecret_msdyn_ocwhatsappchannelaccount_provideracsconnectionstring

One-To-Many Relationship: msdyn_channelinstancesecret msdyn_msdyn_channelinstancesecret_msdyn_ocwhatsappchannelaccount_provideracsconnectionstring

Property	Value
ReferencedEntity	msdyn_channelinstancesecret
ReferencedAttribute	msdyn_channelinstancesecretid
ReferencingAttribute	msdyn_provideracsconnectionstringid
ReferencingEntityNavigationPropertyName	msdyn_provideracsconnectionstringid
IsHierarchical
CascadeConfiguration	Archive: RemoveLink Assign: NoCascade Delete: Restrict Merge: NoCascade Reparent: NoCascade RollupView: NoCascade Share: NoCascade Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

• msdyn_ocwhatsappchannelaccount_msdyn_ocprovisioningstate_msdyn_ocwhatsappchannelaccountId
• msdyn_ocwhatsappchannelaccount_msdyn_ocwhatsappchannelnumber_ocwhatsappaccountid

msdyn_ocwhatsappchannelaccount_msdyn_ocprovisioningstate_msdyn_ocwhatsappchannelaccountId

Many-To-One Relationship: msdyn_ocprovisioningstate msdyn_ocwhatsappchannelaccount_msdyn_ocprovisioningstate_msdyn_ocwhatsappchannelaccountId

Property	Value
ReferencingEntity	msdyn_ocprovisioningstate
ReferencingAttribute	msdyn_ocwhatsappchannelaccountid
ReferencedEntityNavigationPropertyName	msdyn_ocwhatsappchannelaccount_msdyn_ocprovisioningstate_msdyn_ocwhatsappchannelaccountId
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ocwhatsappchannelaccount_msdyn_ocwhatsappchannelnumber_ocwhatsappaccountid

Many-To-One Relationship: msdyn_ocwhatsappchannelnumber msdyn_ocwhatsappchannelaccount_msdyn_ocwhatsappchannelnumber_ocwhatsappaccountid

Property	Value
ReferencingEntity	msdyn_ocwhatsappchannelnumber
ReferencingAttribute	msdyn_ocwhatsappaccountid
ReferencedEntityNavigationPropertyName	msdyn_ocwhatsappchannelaccount_msdyn_ocwhatsappchannelnumber_ocwhatsappaccountid
IsCustomizable	True
AssociatedMenuConfiguration	AvailableOffline: True Behavior: UseCollectionName Group: Details Label: MenuId: null Order: 10000 QueryApi: null ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference