---
schema_version: "1"
id: ad143588590d886b0b59ce07178f993896430c298962449c13e9abc072f03613
title: ChatterSettings
collection: legacydeveloper
version: current
locale: en-us
portal_url: https://docs.salesforce.com/legacydeveloper/current/en-us/api_meta/meta_chattersettings.md
canonical_url: https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_chattersettings.htm
source_site: developer.salesforce.com
content_type: documentation
content_hash: 2379c27b7eb6e5c120e7c160a35c8d80c5a722b9c7ee9db7c5e86aad7d63df73
description: Represents an org’s settings for their Chatter instance when Chatter is enabled for the org. This type extends the Metadata metadata type and inherits its fullName field.
---
# ChatterSettings

Represents an org’s settings for their Chatter instance when Chatter is enabled for the org. This type extends the Metadata metadata type and inherits its fullName field.

In the package manifest, all organization settings metadata types are accessed using the Settings name. See [Settings](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_settings.htm "Represents the organization settings related to a feature. For example, your password policies, session settings and network access controls are all available in the SecuritySettings component type.") for details.

## File Suffix and Directory Location

The ChatterSettings component appears in the Chatter.settings file, and is stored in the settings folder. The .settings files are different from other named components because there’s only one settings file for each settings component.

## Version

ChatterSettings components are available in API version 47.0 and later.

## Fields

<table class="featureTable sort_table" summary="">



          <thead class="thead sorted" align="left">
            <tr>
              <th class="featureTableHeader  " id="d242086e102">Field Name</th>

              <th class="featureTableHeader  " id="d242086e105">Field Type</th>

              <th class="featureTableHeader  " id="d242086e108">Description</th>

            </tr>

          </thead>

          <tbody class="tbody">
            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">allowChatterGroupArchiving</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether manual and automatic group archiving are allowed on all
                Chatter groups (<samp class="codeph nolang">true</samp>) or aren’t allowed
                (<samp class="codeph nolang">false</samp>).<p class="p">In Setup,
                  <span class="keyword parmname">allowChatterGroupArchiving</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Group Archiving</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">allowRecordsInChatterGroup</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether records can be associated with groups (<samp class="codeph nolang">true</samp>), or not (<samp class="codeph nolang">false</samp>). If groups already have record data, setting this field to
                <samp class="codeph nolang">false</samp> doesn’t delete it.<p class="p">In Setup,
                  <span class="keyword parmname">allowRecordsInChatterGroup</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Records in Groups</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">allowSharingInChatterGroup</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Removed. The setting of this field has no effect on the org. Available in API
                version 47.0 only.</td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableApprovalRequest</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether Approvals in Chatter are enabled for the org. When the value
                is <samp class="codeph nolang">true</samp>, users see approval requests as posts
                in Chatter feeds. Users can update their own Chatter feeds settings to opt out of
                receiving approval requests as Chatter posts. When the value is <samp class="codeph nolang">false</samp>, approval requests aren’t posted to Chatter.
                The default value is <samp class="codeph nolang">false</samp>.<p class="p">In Setup,
                  <span class="keyword parmname">enableApprovalRequest</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Approvals</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableCaseFeedRelativeTimestamps</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">In Case feeds, indicates whether to use relative (<samp class="codeph nolang">true</samp>) or absolute (<samp class="codeph nolang">false</samp>) date and
                time stamp formats on Case feed items. When the value is <samp class="codeph nolang">true</samp>, Case feed items show a relative timestamp (for example,
                <samp class="ph systemoutput">10m ago</samp>). When the value is <samp class="codeph nolang">true</samp>,
                users can hover over the relative timestamp to see the absolute. When the value is
                <samp class="codeph nolang">false</samp>, Case feed items show an absolute
                timestamp (for example, <samp class="ph systemoutput">January 7, 2020 at 12:15PM</samp>).
                When you change this setting, all timestamps in Case feeds reflect that change. The
                default value is <samp class="codeph nolang">true</samp>. This field is available
                in API version 48.0 and later.<p class="p">In Setup,
                  <span class="keyword parmname">enableCaseFeedRelativeTimestamps</span> equates to the Chatter
                  setting <strong class="ph uicontrol">Show relative timestamp</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableChatter</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether Chatter is enabled for your org (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>).</td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableChatterEmoticons</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether the automatic conversion of text characters, such as :), into
                a graphic emoticon is allowed in Chatter (<samp class="codeph nolang">true</samp>)
                or isn’t allowed (<samp class="codeph nolang">false</samp>).<p class="p">In Setup,
                  <span class="keyword parmname">enableChatter</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Emoticons</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableFeedEdit</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether qualified users can edit feed posts and comments (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). Qualified users include:<div class="p">
                  <ul class="ul bulletList">
                    <li class="li">The author of the post or comment</li>

                    <li class="li">The person who owns the record that was posted to or commented on</li>

                    <li class="li">The Chatter or site moderator</li>

                  </ul>

                </div>
                <p class="p">In Setup, <span class="keyword parmname">enableFeedEdit</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow users to edit posts and comments</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableFeedPinning</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to allow the pinning of posts in a feed
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to
                <samp class="codeph nolang">true</samp>:<div class="p">
                  <ul class="ul bulletList">
                    <li class="li">Authorized users can pin posts to the top of the feed.</li>

                    <li class="li">The feed supports up to three pinned posts.</li>

                    <li class="li">Pinned posts stay pinned until they’re unpinned.</li>

                  </ul>

                </div>
                <p class="p">After post pinning is enabled, authorized users include admins and group
                  owners and managers. Admins can also assign post pinning permission through
                  permission sets or user profiles.</p>
                <p class="p">In Setup,
                  <span class="keyword parmname">enableFeedPinning</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow post pinning</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableFeedsDraftPosts</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether draft posts are automatically saved every seven seconds
                (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). When set to <samp class="codeph nolang">true</samp>:<div class="p">
                  <ul class="ul bulletList">
                    <li class="li">Adds the My Drafts feed to the Chatter tab</li>

                    <li class="li">Saves draft posts automatically every seven seconds</li>

                    <li class="li">Makes drafts available in the My Drafts feed</li>

                  </ul>

                </div>
                When the user posts the entry, the draft is automatically removed from the My
                Drafts feed.<p class="p">In Setup, <span class="keyword parmname">enableFeedsDraftPosts</span> equates to the
                  Chatter setting <strong class="ph uicontrol">Allow draft posts</strong>.</p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableFeedsRichText</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to use the Rich Text Editor in the Chatter Publisher (<samp class="codeph nolang">true</samp>) or not (<samp class="codeph nolang">false</samp>). The rich text editor supports text formats, inline images,
                hyperlinks, and, when enabled for the org, code snippets.<p class="p">In Setup,
                  <span class="keyword parmname">enableFeedsRichText</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow users to compose rich text posts</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableInviteCsnUsers</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether a licensed user can invite customers to private groups that
                the licensed user owns or manages (<samp class="codeph nolang">true</samp>) or not
                (<samp class="codeph nolang">false</samp>). When the value is set to
                <samp class="codeph nolang">true</samp>, licensed users can invite customers who are from outside
                org email domains. Invited customers can see information only in the groups that
                they're invited to. They can interact only with members of those groups.<p class="p">In Setup,
                  <span class="keyword parmname">enableInviteCsnUsers</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow customer invitations</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableOutOfOfficeEnabledPref</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to add an Out of Office setting to a user profile page
                (<samp class="codeph nolang">true</samp>), or to omit it (<samp class="codeph nolang">false</samp>). When the value is set to <samp class="codeph nolang">true</samp>, this option adds a control to user profile
                pages for setting a personal out-of-office message.<p class="p">In Setup,
                  <span class="keyword parmname">enableOutOfOfficeEnabledPref</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Users can set Out of Office message</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableRichLinkPreviewsInFeed</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to convert links in posts into embedded videos, images, and
                article previews (<samp class="codeph nolang">true</samp>) or not to convert the
                links (<samp class="codeph nolang">false</samp>). <p class="p">In Setup,
                  <span class="keyword parmname">enableRichLinkPreviewsInFeed</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Rich Link Previews</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">enableTodayRecsInFeed</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to allow the posting of recommendations for using the
                Salesforce Today app in users’ feeds (<samp class="codeph nolang">true</samp>) or
                not (<samp class="codeph nolang">false</samp>). When set to <samp class="codeph nolang">true</samp>, automatically posts recommendations for using
                the Salesforce Today app in users’ feeds.<p class="p">In Setup,
                  <span class="keyword parmname">enableTodayRecsInFeed</span> equates to the Chatter setting
                  <strong class="ph uicontrol">Allow Today Recommendations</strong>.
                </p>
              </td>

            </tr>

            <tr>
              <td class="entry" headers="d242086e102" data-title="Field Name"><span class="keyword parmname">unlistedGroupsEnabled</span></td>

              <td class="entry" headers="d242086e105" data-title="Field Type">boolean</td>

              <td class="entry" headers="d242086e108" data-title="Description">Indicates whether to allow the creation of unlisted groups (<samp class="codeph nolang">true</samp>) or to prevent their creation (<samp class="codeph nolang">false</samp>). When the value is set to <samp class="codeph nolang">true</samp>, users can create unlisted groups. Unlisted
                groups don’t appear on the Groups list page. Membership in unlisted groups is by
                invitation only.<p class="p">In Setup, <span class="keyword parmname">unlistedGroupsEnabled</span> equates to
                  the Chatter setting <strong class="ph uicontrol">Enable Unlisted Groups</strong>.</p>
              </td>

            </tr>

          </tbody>

        </table>

## Declarative Metadata Sample Definition

The following is an example of a Chatter.settings file.

<?xml version="1.0" encoding="UTF-8"?>
 <ChatterSettings xmlns="http://soap.sforce.com/2006/04/metadata">
     <allowChatterGroupArchiving\>true</allowChatterGroupArchiving\>
     <allowRecordsInChatterGroup\>true</allowRecordsInChatterGroup\>
     <enableApprovalRequest\>true</enableApprovalRequest\>
     <enableChatter\>true</enableChatter\>
     <enableChatterEmoticons\>true</enableChatterEmoticons\>
     <enableFeedEdit\>true</enableFeedEdit\>
     <enableFeedsDraftPosts\>false</enableFeedsDraftPosts\>
     <enableFeedsRichText\>true</enableFeedsRichText\>
     <enableInviteCsnUsers\>true</enableInviteCsnUsers\>
     <enableOutOfOfficeEnabledPref\>false</enableOutOfOfficeEnabledPref\>
     <enableRichLinkPreviewsInFeed\>true</enableRichLinkPreviewsInFeed\>
     <enableTodayRecsInFeed\>true</enableTodayRecsInFeed\>
     <unlistedGroupsEnabled\>true</unlistedGroupsEnabled\>
 </ChatterSettings\>

The following is an example package.xml manifest that references the ChatterSettings definitions:

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
    <types\>
        <members\>Chatter</members\>
        <name\>Settings</name\>
    </types\>
    <version\>47.0</version\>
</Package\>

## Wildcard Support in the Manifest File

The wildcard character \* (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see [Settings](https://developer.salesforce.com/docs/atlas.en-us.264.0.api_meta.meta/api_meta/meta_settings.htm). 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).