CommunicationChannelType

Represents the channel type, such as WhatsApp or Telegram that’s used for communication.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

CommunicationChannelType components have the suffix .communicationChannelType and are stored in the communicationChannelTypes folder.

Version

CommunicationChannelType components are available in API version 63.0 and later.

Special Access Rules

To use this metadata type, your org must have at least one of these features enabled:

Industries Offer Management
Industries Referral Marketing

Fields

channelName

Field Type: string

Description: Required. Name of the channel that’s used for communication, such as WhatsApp or Telegram.

masterLabel

Field Type: string

Description: Required. A user-friendly name for communication channel type, which is defined when the communication channel type is created.

Declarative Metadata Sample Definition

The following is an example of a CommunicationChannelType component.

1<?xml version="1.0" encoding="UTF-8"?>
2<CommunicationChannelType xmlns="http://soap.sforce.com/2006/04/metadata">
3    <masterLabel>Test1</masterLabel>
4    <channelName>WhatsApp</channelName>
5</CommunicationChannelType>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>*</members>
5        <name>CommunicationChannelType</name>
6    </types>
7    <version>68.0</version>
8</Package>

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.