--- schema_version: "1" id: 32a2ac914c7b158a107acc1adfbf819d6bf045c324c1947479e34eff57fa3bab title: ConversationMessageDefinition collection: legacydeveloper version: current locale: en-us portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_conversationmessagedefinition.md canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_conversationmessagedefinition.htm source_site: developer.salesforce.com content_type: documentation content_hash: 755db8fafd0a94f1a08bac6490270faebac7de462ec05ff901ea4076d537f38b description: Represents a messaging component in an Enhanced Messaging channel or Messaging for In-App and Web session. --- # ConversationMessageDefinition Represents a messaging component in an Enhanced Messaging channel or Messaging for In-App and Web session. ## Parent Type This type extends the [Metadata](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/metadata.htm) metadata type and inherits its fullName field. ## File Suffix and Directory Location ConversationMessageDefinition components have the suffix .conversationMessageDefinition and are stored in the conversationMessageDefinitions folder. ## Version ConversationMessageDefinition is supported for use in enhanced Messaging channels and Messaging for In-App and Web, and is available in API version 59.0 and later. ## Fields | Field Name | Description | | --- | --- | | constants | Field Type [ConversationMessageConstant](#ConversationMessageConstant)\[\] Description An array of constants that defines the messaging components. Constants support multiple data types, including text, URL, and image. | | contentCategory | Field Type ConversationMessageContentCategory (enumeration of type string) Description Specifies the business intent of the Conversation Message Definition. Valid values are: - AccountUpdate - Authentication - Feedback - OrderUpdate - PromotionalOutreach - Reminder - Response | | description | Field Type string Description The description of the conversation message definition. | | label | Field Type string Description A user-friendly name for ConversationMessageDefinition, which is defined whenConversationMessageDefinition is created. | | language | Field Type string Description The language of the conversation message definition. | | messageHandlers | Field Type [ConversationMessageHandler](#ConversationMessageHandler)\[\] Description An array of message handlers. | | messageLayouts | Field Type [ConversationMessageLayout](#ConversationMessageLayout)\[\] Description An array of message layouts. | | optionsParameter | Field Type [ConversationMessageOptionsParameter](#ConversationMessageOptionsParameter)\[\] Description An array of options parameter of the ConversationMessageDefinition. | | parameters | Field Type [ConversationMessageParameter](#ConversationMessageParameter)\[\] Description An array of parameters. | | type | Field Type ConversationMessageDefinitionType (enumeration of type string) Description Required. The type of the conversation message definition. Valid values are: - Action - ApexForm - AuthenticationRequest - AutoResponse - GuidedActions—Available in API version 68.0 and later. - Link - Notification - PaymentRequest - Picklist - RecordPicker - RecordView - TimePicker | ## ConversationMessageConstant Represents a constant value on the messaging component. When a messaging component is created in the UI, the text and images entered during creation are saved as standard constants. Custom constants can also be added. | Field Name | Description | | --- | --- | | compositeValues | Field Type [ConversationMessageConstantCompositeValue](#ConversationMessageConstantCompositeValue)\[\] Description An array of composite values of ConversationMessageConstant. | | constantType | Field Type ConversationMessageConstantType (enumeration of type string) Description Required. The conversation message constant type. Valid values are: - Custom - Image - Options - SubTitle - Title - Url | | label | Field Type string Description The UI label of the conversation message constant. | | name | Field Type string Description The name of the conversation message constant. | | primitiveValues | Field Type [ConversationMessageConstantPrimitiveValue](#ConversationMessageConstantPrimitiveValue) (enumeration of type string) Description An array of primitive values of ConversationMessageConstant. | | valueType | Field Type ConversationMessageValueType (enumeration of type string) Description The type of the conversation message constant value. Valid values are: - Boolean - Date - DateTime - Double - ImageId - Integer - RecordId - Text - Url - VideoId—Available in API version 68.0 and later. | ## ConversationMessageConstantCompositeValue Represents the composite values of the [ConversationMessageConstant](#ConversationMessageConstant). | Field Name | Description | | --- | --- | | constantItems | Field Type [ConversationMessageConstant](#ConversationMessageConstant)\[\] Description An array of constant items. | | identifier | Field Type string Description Required. The client identifier. | ## ConversationMessageConstantPrimitiveValue Represents the primitive values of the [ConversationMessageConstant](#ConversationMessageConstant). | Field Name | Description | | --- | --- | | contentAssetName | Field Type string Description Represents the value for type = ImageAsset | | textValue | Field Type string Description Represents the value for type = Text | | type | Field Type ConversationMessageConstantValueType (enumeration of type string) Description Required. The type of the conversation message constant primitive value. Valid values are: - FileAsset - ImageAsset - Text - Url | | urlValue | Field Type string Description Represents the value for type = Url | ## ConversationMessageHandler Represents the conversation message handler. | Field Name | Description | | --- | --- | | activeRequestDurationMinutes | Field Type int Description Required. The duration of an active request in minutes. | | handlerName | Field Type string Description Required. The name of the message handler. | | handlerType | Field Type ConversationMessageHandlerType (enumeration of type string) Description Required. The type of message handler. Valid values are: - ApexFormProvider. Available in API version 65.0 and later. - AuthProvider - PaymentProvider - QuickAction - Survey. Available in API version 65.0 and later. | ## ConversationMessageLayout Represents the conversation message layout. | Field Name | Description | | --- | --- | | externalTemplates | Field Type [ConvMsgExternalTemplateVersion](#ConvMsgExternalTemplateVersion)\[\] Description The external template version of the ConversationMessageLayout. | | formatType | Field Type ConversationMessageFormatType (enumeration of type string) Description Required. The format type of the conversation message layout. Valid values are: - Application - BusinessUpdate—Available in API version 68.0 and later. - Buttons - Carousel - EncryptedOAuthToken - ExternalTemplate - Flow - Inputs - ListPicker - Media - Payment - QuickReplies - RichLink - Suggestions—Available in API version 68.0 and later. - Text - TimePicker - WebView | | layoutItems | Field Type [ConversationMessageLayoutItem](#ConversationMessageLayoutItem)\[\] Description An array of layout items. | | messageType | Field Type ConversationMessageType (enumeration of type string) Description Required. The conversation message type. Valid values are: - AuthenticationRequest - Choices - Form - PaymentRequest - StaticContent | ## ConvMsgExternalTemplateVersion Represents the external template version of the conversation message layout. | Field Name | Description | | --- | --- | | accountIdentifier | Field Type string Description Required. The account identifier. For WhatsApp channels, this is the WABA ID. | | accountName | Field Type string Description Required. The account name. | | language | Field Type string Description Required. The language of the conversation message external template. | | status | Field Type ConvMsgExternalTemplateVersionStatus (enumeration of type string) Description Required. The status of the conversation message external template. Valid values are: - Approved. The template version is approved. - Blocked. The template version is blocked. Available in API version 65.0 and later. - Deleted. The template version is deleted. Available in API version 65.0 and later. - Disabled. The template version is disabled because of recurring negative customer feedback. - InAppeal. The rejected template version is being appealed. Available in API version 65.0 and later. - LimitExceeded. Available in API version 65.0 and later. - OutOfSync. The template versions in the messaging service and Salesforce are out of sync. Available in API version 65.0 and later. - Paused. The template version is paused because of recurring negative customer feedback or low read rates. - Pending. The template version awaits Meta's approval. - PendingDeletion. The template version is pending deletion. Available in API version 65.0 and later. - Rejected. The template version was rejected during Meta’s review process. | | templateName | Field Type string Description Required. The name of the conversation message external template. | | templateVersionIdentifier | Field Type string Description Required. The template version identifier. | ## ConversationMessageLayoutItem Represents the conversation message layout item. | Field Name | Description | | --- | --- | | collectionType | Field Type ConversationMessageCollectionType (enumeration of type string) Description Required. The type of conversation message collection. Valid values are: - DynamicList - None - StaticList | | compositeValues | Field Type [ConversationMessageLayoutCompositeValue](#ConversationMessageLayoutCompositeValue)\[\] Description An array of composite values of the ConversationMessageLayoutItem. | | name | Field Type string Description The name of the conversation message layout item. | | primitiveValues | Field Type [ConversationMessageLayoutPrimitiveValue](#ConversationMessageLayoutPrimitiveValue)\[\] Description An array of primitive values of the ConversationMessageLayoutItem. | ## ConversationMessageLayoutCompositeValue Represents the composite value of the [ConversationMessageLayoutItem](#ConversationMessageLayoutItem). | Field Name | Description | | --- | --- | | compositeTypeName | Field Type string Description Required. The name of the conversation message layout composite value type. | | layoutItems | Field Type [ConversationMessageLayoutItem](#ConversationMessageLayoutItem)\[\] Description An array of layout items. | | valueSourceReference | Field Type string Description The source of the conversation message layout composite value. | ## ConversationMessageLayoutPrimitiveValue Represents the primitive value of the [ConversationMessageLayoutItem](#ConversationMessageLayoutItem). | Field Name | Description | | --- | --- | | contentAssetName | Field Type string Description The content asset name. | | fieldName | Field Type string Description The name of the conversation message layout primitive value field. | | formulaTemplate | Field Type string Description The formula template defines the content for each entry in the list. | | literalValue | Field Type string Description The literal primitive value of the conversation message layout. | | mergeFields | Field Type [ConversationMessageMergeField](#ConversationMessageMergeField)\[\] Description Inserts multiple values to a list. | | type | Field Type ConversationMessageLayoutValueType (enumeration of type string) Description Required. The type of the conversation message layout primitive value. Valid values are: - FormulaTemplate - Literal - MediaAsset - SourcePrimitiveValue - SourceSobjectField - SourceSobjectFieldValue - SourceSobjectFormula | | valueFormula | Field Type string Description The formula of the conversation message layout primitive value. | | valueSourceReference | Field Type string Description The source of the conversation message layout primitive value. | ## ConversationMessageMergeField Merge field is used to insert multiple values to a list. | Field Name | Description | | --- | --- | | formulaTemplate | Field Type string Description Required. The formula template of the conversation message merge field. | | mergeFieldType | Field Type ConversationMessageMergeFieldType (enumeration of type string) Description Required. The type of the conversation message merge field. Valid value is ListTemplate. | | name | Field Type string Description Required. The name of the conversation message merge field. | | valueSourceReference | Field Type string Description Required. The source of the conversation message merge field value. | ## ConversationMessageOptionsParameter Represents a conversation message options parameter. | Field Name | Description | | --- | --- | | compositeTypeDetails | Field Type [ConversationMessageParameterCompositeDetails](#ConversationMessageParameterCompositeDetails)\[\] Description An array of composite details of ConversationMessageOptionsParameter. | | optionsParameterType | Field Type ConversationMessageOptionsParameterType (enumeration of type string) Description Required. The type of conversation message options parameter. Valid values are: - CustomCompositeOptions - CustomPrimitiveOptions - RecordIdOptions - TimeSlotOptions | | primitiveTypeDetails | Field Type ConversationMessageParameterPrimitiveDetails Description The primitive type details of conversation message options parameter. | ## ConversationMessageParameterCompositeDetails Represents the composite details of a conversation message parameter. | Field Name | Description | | --- | --- | | compositeChildItems | Field Type ConversationMessageParameterCompositeDetails\[\] Description The composite child items of the conversation message parameter. | | isList | Field Type boolean Description Indicates whether the conversation message parameter composite details field is a list item (true) or not (false). The default value is false. | | isRequired | Field Type boolean Description Indicates whether the conversation message parameter is required (true) or not (false). The default value is false. | | label | Field Type string Description The UI label of the conversation message parameter composite details field. | | maxListItems | Field Type int Description The maximum number of list items in the conversation message parameter composite details field. | | name | Field Type string Description The name of the conversation message parameter composite details field. | | primitiveChildItems | Field Type [ConversationMessageParameterPrimitiveDetails](#ConversationMessageParameterPrimitiveDetails)\[\] Description An array of primitive child items. | ## ConversationMessageParameterPrimitiveDetails Represents the primitive details of the conversation message parameter. | Field Name | Description | | --- | --- | | isList | Field Type boolean Description Indicates whether the conversation message parameter primitive details field is a list item (true) or not (false). The default value is false. | | isRequired | Field Type boolean Description Indicates whether the conversation message parameter primitive details field is required (true) or not (false). The default value is false. | | label | Field Type string Description The UI label of the conversation message parameter primitive details field. | | maxListItems | Field Type int Description The maximum number of list items that are allowed in the conversation message parameter primitive details field. | | name | Field Type string Description The name of the conversation message parameter primitive details field. | | sobjectType | Field Type string Description The sObject type. | | valueType | Field Type ConversationMessageValueType (enumeration of type string) Description The type of the conversation message parameter value. Valid values are: - Boolean - Date - DateTime - Double - ImageId - Integer - RecordId - Text - Url - VideoId—Available in API version 68.0 and later. | ## ConversationMessageParameter Represents a conversation message parameter. | Field Name | Description | | --- | --- | | compositeTypeDetails | Field Type [ConversationMessageParameterCompositeDetails](#ConversationMessageParameterCompositeDetails) Description An array of composite type details. | | parameterType | Field Type ConversationMessageParameterType (enumeration of type string) Description Required. The type of conversation message parameter. Valid values are: - CustomComposite - CustomPrimitive - RecordIds | | primitiveTypeDetails | Field Type [ConversationMessageParameterPrimitiveDetails](#ConversationMessageParameterPrimitiveDetails) Description An array of primitive type details. | ## Declarative Metadata Sample Definition The following is an example of a ConversationMessageDefinition component. Custom imageAsset imageAsset Screenshot\_20240402\_at\_32437PM ImageAsset ImageId Custom message message Favourite Season Text Text Custom Prompt1 Prompt1 Choose one option Text Text Image Screenshot\_20240321\_at\_53957PM3 ImageAsset SubTitle January Text Title Jan Text 1c6f8c4d-7bce-1649-fa45-db587bcfbb29 Image Screenshot\_20240321\_at\_53957PM4 ImageAsset SubTitle December Text Title Dec Text fb8bb328-7bc7-2830-6194-2ae7ece055ad Image Screenshot\_20240321\_at\_53912PM1 ImageAsset SubTitle March Text Title March Text 570baa88-fa4d-4b31-0e84-92f87b35af0a Options Title What is your favourite month? Text Favourite Month en\_US Buttons DynamicList TitleOptionItem None TitleItem None title SourcePrimitiveValue Constants.Options.ListItem.SubTitle titleItem Constants.Options optionItems None text SourcePrimitiveValue Constants.Title Choices ListPicker None TitleImageItem None imageId SourcePrimitiveValue Constants.imageAsset None title SourcePrimitiveValue Constants.Title message DynamicList TitleOptionItem None TitleImageItem None imageId SourcePrimitiveValue Constants.Options.ListItem.Image None title SourcePrimitiveValue Constants.Options.ListItem.Title titleItem Constants.Options optionItems None TitleImageItem None imageId SourcePrimitiveValue Constants.imageAsset None title SourcePrimitiveValue Constants.message reply None title SourcePrimitiveValue Constants.Title Choices Carousel DynamicList TitleItemWithInteractions StaticList TitleOptionItem None TitleItem None title Select One Literal titleItem interactionItems None TitleImageItem None imageId SourcePrimitiveValue Constants.Options.ListItem.Image None subTitle SourcePrimitiveValue Constants.Options.ListItem.SubTitle None title SourcePrimitiveValue Constants.Title titleItem Constants.Options items Choices Text None text {!$Constants.Title} {!$Constants.Prompt1}: {!$ListTemplates.OptionsList} {!$ListItem.Index}. {!$ListItem.Value.Title}{!BR()} ListTemplate OptionsList Constants.Options FormulaTemplate StaticContent Picklist The following is an example package.xml that references the previous definition. Favourite\_Month ConversationMessageDefinition 61.0 ## Wildcard Support in the Manifest File This metadata type supports the wildcard character \* (asterisk) in the package.xml manifest file. For information about using the manifest file, see [Deploying and Retrieving Metadata with the Zip File](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/file_based_zip_file.htm).