Message Template (msdyn_oc_message_template) table/entity reference (Microsoft Dynamics 365 Field Service)

Provider-agnostic catalog of reusable message templates (WhatsApp / SMS / MMS / RCS) that Omnichannel consumers fetch or create across providers (Meta-Direct, ACS, Twilio).

Messages

The following table lists the messages for the Message Template (msdyn_oc_message_template) 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
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_oc_message_templates See Create	Create records
CreateMultiple Event: True	CreateMultiple	CreateMultipleRequest
Delete Event: True	DELETE /msdyn_oc_message_templates(msdyn_oc_message_templateid) See Delete	Delete records
Disassociate Event: True	Disassociate records	Disassociate records
IsValidStateTransition Event: False	IsValidStateTransition	IsValidStateTransitionRequest
PurgeRetainedContent Event: True	PurgeRetainedContent	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_oc_message_templates(msdyn_oc_message_templateid) See Retrieve	Retrieve records
RetrieveMultiple Event: True	GET /msdyn_oc_message_templates See Query data	Query data
RollbackRetain Event: True	RollbackRetain	Learn to use messages with the SDK for .NET
SetState Event: True	PATCH /msdyn_oc_message_templates(msdyn_oc_message_templateid) Update the statecode and statuscode properties.	SetStateRequest
Update Event: True	PATCH /msdyn_oc_message_templates(msdyn_oc_message_templateid) See Update	Update records
UpdateMultiple Event: True	UpdateMultiple	UpdateMultipleRequest
Upsert Event: False	PATCH /msdyn_oc_message_templates(msdyn_oc_message_templateid) 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 Message Template (msdyn_oc_message_template) table.

Property	Value
DisplayName	Message Template
DisplayCollectionName	Message Templates
SchemaName	msdyn_oc_message_template
CollectionSchemaName	msdyn_oc_message_templates
EntitySetName	msdyn_oc_message_templates
LogicalName	msdyn_oc_message_template
LogicalCollectionName	msdyn_oc_message_templates
PrimaryIdAttribute	msdyn_oc_message_templateid
PrimaryNameAttribute	msdyn_name
TableType	Standard
OwnershipType	OrganizationOwned

Writable columns/attributes

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

• ImportSequenceNumber
• IsCustomizable
• msdyn_bodytext
• msdyn_category
• msdyn_channelinstanceid
• msdyn_channeltype
• msdyn_content
• msdyn_displayname
• msdyn_language
• msdyn_lastsyncedon
• msdyn_name
• msdyn_oc_message_template_type
• msdyn_oc_message_templateId
• msdyn_providerlastupdatedon
• msdyn_providerstatus
• msdyn_providertemplateid
• msdyn_providertype
• msdyn_qualityscore
• msdyn_rejectionreason
• OverriddenCreatedOn
• 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_bodytext

Property	Value
Description	Denormalized body text for quick preview and search. Non-authoritative; the authoritative structure lives in Content.
DisplayName	Body Text
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_bodytext
RequiredLevel	None
Type	Memo
Format	TextArea
FormatName	TextArea
ImeMode	Auto
IsLocalizable	False
MaxLength	4000

msdyn_category

Property	Value
Description	WhatsApp template category (Marketing / Utility / Authentication). Null for non-WhatsApp providers.
DisplayName	Category
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_category
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	msdyn_oc_message_template_category

msdyn_category Choices/Options

Value	Label
700610000	Marketing
700610001	Utility
700610002	Authentication

msdyn_channelinstanceid

Property	Value
Description	WABA / channel instance the template belongs to. Part of the alternate key; must never be null — use a reserved sentinel for instance-less rows.
DisplayName	Channel Instance Id
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_channelinstanceid
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	100

msdyn_channeltype

Property	Value
Description	Channel the template belongs to (WhatsApp / SMS). The format within the channel is carried separately by Template Format.
DisplayName	Channel Type
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_channeltype
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	msdyn_oc_message_template_channeltype

msdyn_channeltype Choices/Options

Value	Label
700610000	WhatsApp
700610001	SMS

msdyn_content

Property	Value
Description	Uniform self-describing JSON definition of the template (provider structure plus parameter definitions). WhatsApp components; MMS {text, mediaAttachments}; SMS {text}.
DisplayName	Content
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_content
RequiredLevel	ApplicationRequired
Type	Memo
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	1048576

msdyn_displayname

Property	Value
Description	Optional friendly label shown in the template picker.
DisplayName	Display Name
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_displayname
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

msdyn_language

Property	Value
Description	Canonical BCP-47 language code (e.g. en-US). The provider-specific code is resolved at the provider adapter, not stored here.
DisplayName	Language
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_language
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	20

msdyn_lastsyncedon

Property	Value
Description	Timestamp of the last reconcile of this catalog row with the provider (cache providers).
DisplayName	Last Synced On
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_lastsyncedon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	TimeZoneIndependent
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

msdyn_name

Property	Value
Description	Provider template name — the value sent to the provider.
DisplayName	Name
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_name
RequiredLevel	ApplicationRequired
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

msdyn_oc_message_template_type

Property	Value
Description	Message format / channel discriminator (SMS / MMS / RCS / WhatsApp). Part of the alternate key, so it is always populated with the row's single canonical value.
DisplayName	Template Format
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_oc_message_template_type
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	msdyn_octemplateformat

msdyn_oc_message_template_type Choices/Options

Value	Label
100000000	SMS
100000001	MMS
100000002	RCS
100000004	WhatsApp

msdyn_oc_message_templateId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Message Template
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_oc_message_templateid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_providerlastupdatedon

Property	Value
Description	Provider's last-updated timestamp for the template (UTC).
DisplayName	Provider Last Updated On
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providerlastupdatedon
RequiredLevel	None
Type	DateTime
CanChangeDateTimeBehavior	False
DateTimeBehavior	TimeZoneIndependent
Format	DateAndTime
ImeMode	Inactive
SourceTypeMask	0

msdyn_providerstatus

Property	Value
Description	Template lifecycle status reported by the provider (e.g. Meta approval state).
DisplayName	Provider Status
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providerstatus
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	msdyn_oc_message_template_providerstatus

msdyn_providerstatus Choices/Options

Value	Label
700610000	Approved
700610001	Pending
700610002	Rejected
700610003	Paused
700610004	Disabled
700610005	In Appeal
700610006	Pending Deletion

msdyn_providertemplateid

Property	Value
Description	Provider-side identifier where one exists (e.g. Meta template id); null for authored ACS / MMS templates.
DisplayName	Provider Template Id
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providertemplateid
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	200

msdyn_providertype

Property	Value
Description	Messaging provider that owns this template (Twilio / Azure Communication Services / Meta).
DisplayName	Provider Type
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_providertype
RequiredLevel	ApplicationRequired
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	msdyn_oc_message_template_providertype

msdyn_providertype Choices/Options

Value	Label
192350000	Twilio
192350001	Azure Communication Services
192350002	Meta

msdyn_qualityscore

Property	Value
Description	Provider-reported quality rating for the template (Green / Yellow / Red).
DisplayName	Quality Score
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_qualityscore
RequiredLevel	None
Type	Picklist
DefaultFormValue	-1
GlobalChoiceName	msdyn_oc_message_template_qualityscore

msdyn_qualityscore Choices/Options

Value	Label
700610000	Green
700610001	Yellow
700610002	Red

msdyn_rejectionreason

Property	Value
Description	Reason supplied by the provider when the template was rejected.
DisplayName	Rejection Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_rejectionreason
RequiredLevel	None
Type	String
Format	Text
FormatName	Text
ImeMode	Auto
IsLocalizable	False
MaxLength	500

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

statecode

Property	Value
Description	Status of the Message Template
DisplayName	Status
IsValidForForm	True
IsValidForRead	True
LogicalName	statecode
RequiredLevel	SystemRequired
Type	State
DefaultFormValue
GlobalChoiceName	msdyn_oc_message_template_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 Message Template
DisplayName	Status Reason
IsValidForForm	True
IsValidForRead	True
LogicalName	statuscode
RequiredLevel	None
Type	Status
DefaultFormValue
GlobalChoiceName	msdyn_oc_message_template_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
• OrganizationId
• OverwriteTime
• 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

OrganizationId

Property	Value
Description	Unique identifier for the organization
DisplayName	Organization Id
IsValidForForm	False
IsValidForRead	True
LogicalName	organizationid
RequiredLevel	None
Type	Lookup
Targets	organization

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

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

One-to-Many relationships

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

msdyn_proactive_engagement_message_template_msdyn_oc_message_template

Many-To-One Relationship: msdyn_proactive_engagement_message_template msdyn_proactive_engagement_message_template_msdyn_oc_message_template

Property	Value
ReferencingEntity	msdyn_proactive_engagement_message_template
ReferencingAttribute	msdyn_ocmessagetemplateid
ReferencedEntityNavigationPropertyName	msdyn_proactive_engagement_message_template_msdyn_oc_message_template
IsCustomizable	False
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