msdyn_cannedmessage Entity Reference

Omnichannel for Customer Service offers a suite of capabilities that extend the power of Dynamics 365 Customer Service Enterprise to enable organizations to instantly connect and engage with their customers across digital messaging channels. An additional license is required to access Omnichannel for Customer Service. For more information, see the Dynamics 365 Customer Service pricing overview and Dynamics 365 Customer Service pricing plan pages.

Stores the quick replies that agents can use in the conversation control while interacting with the customers

Added by: Omnichannel – Base Solution

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.1/msdyn_cannedmessages
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.1/msdyn_cannedmessages(msdyn_cannedmessageid)
See Delete
DeleteRequest or
Delete
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
Retrieve GET [org URI]/api/data/v9.1/msdyn_cannedmessages(msdyn_cannedmessageid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.1/msdyn_cannedmessages
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH [org URI]/api/data/v9.1/msdyn_cannedmessages(msdyn_cannedmessageid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.1/msdyn_cannedmessages(msdyn_cannedmessageid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName msdyn_cannedmessages
DisplayCollectionName Quick replies
DisplayName Quick reply
EntitySetName msdyn_cannedmessages
IsBPFEntity False
LogicalCollectionName msdyn_cannedmessages
LogicalName msdyn_cannedmessage
OwnershipType OrganizationOwned
PrimaryIdAttribute msdyn_cannedmessageid
PrimaryNameAttribute msdyn_title
SchemaName msdyn_cannedmessage

Writable attributes

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

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_cannedmessageId

Property Value
Description Unique identifier for entity instances
DisplayName Quick reply
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_cannedmessageid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_Locale_Field

Property Value
Description The locale of a canned message
DisplayName Locale
IsValidForForm True
IsValidForRead True
LogicalName msdyn_locale_field
RequiredLevel ApplicationRequired
Type Picklist

msdyn_Locale_Field Options

Value Label
1025 ar-SA
1026 bg-BG
1027 ca-ES
1028 zh-TW
1029 cs-CZ
1030 da-DK
1031 de-DE
1032 el-GR
1033 en-US
1035 fi-FI
1036 fr-FR
1037 he-IL
1038 hu-HU
1040 it-IT
1041 ja-JP
1042 ko-KR
1043 nl-NL
1044 nb-NO
1045 pl-PL
1046 pt-BR
1048 ro-RO
1049 ru-RU
1050 hr-HR
1051 sk-SK
1053 sv-SE
1054 th-TH
1055 tr-TR
1057 id-ID
1058 uk-UA
1060 sl-SI
1061 et-EE
1062 lv-LV
1063 lt-LT
1066 vi-VN
1069 eu-ES
1081 hi-IN
1086 ms-MY
1087 kk-KZ
1110 gl-ES
2052 zh-CN
2070 pt-PT
3076 zh-HK
3082 es-ES
3098 sr-Cyrl-CS

msdyn_message

Property Value
Description Canned message text
DisplayName Message
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_message
MaxLength 4000
RequiredLevel ApplicationRequired
Type Memo

msdyn_tagscontrolfield

Added by: Omnichannel - Base Patch Solution

Property Value
Description Dummy field to render the tags control
DisplayName TagsControlField
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_tagscontrolfield
MaxLength 100
RequiredLevel None
Type String

msdyn_title

Property Value
Description The name of the custom entity.
DisplayName Title
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_title
MaxLength 100
RequiredLevel ApplicationRequired
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

statecode

Property Value
Description Status of the Quick replies
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 Quick replies
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

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

OrganizationId

Added by: Active Solution Solution

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

OrganizationIdName

Added by: Active Solution Solution

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

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-Many Relationships

Relationship details provided where the msdyn_cannedmessage entity is the first entity in the relationship. Listed by SchemaName.

msdyn_msdyn_cannedmessage_liveworkstream

IntersectEntityName: msdyn_msdyn_cannedmessage_liveworkstream

Entity 1

Property Value
IntersectAttribute msdyn_cannedmessageid
IsCustomizable True
LogicalName msdyn_cannedmessage
NavigationPropertyName msdyn_msdyn_cannedmessage_liveworkstream
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

Entity 2

Property Value
LogicalName msdyn_liveworkstream
IntersectAttribute msdyn_liveworkstreamid
NavigationPropertyName msdyn_msdyn_cannedmessage_liveworkstream
AssociatedMenuConfiguration Behavior: DoNotDisplay
Group: Details
Label:
Order:

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