ChatterSettings | Metadata API Developer Guide

In the package manifest, all organization settings metadata types are accessed using the “Settings” name. See Settings for more 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 is only one settings file for each settings component.

Version

ChatterSettings components are available in API version 47.0 and later.

Fields

Field Name	Field Type	Description
allowChatterGroupArchiving	boolean	Indicates whether manual and automatic group archiving are allowed on all Chatter groups (`true`) or aren’t allowed (`false`). In Setup, allowChatterGroupArchiving equates to the Chatter setting Allow Group Archiving.
allowRecordsInChatterGroup	boolean	Indicates whether records can be associated with groups (`true`), or not (`false`). Setting this field to `false` doesn’t delete existing record data from groups. In Setup, allowRecordsInChatterGroup equates to the Chatter setting Allow Records in Groups.
allowSharingInChatterGroup	boolean	Removed. The setting of this field has no effect on the org. Available in API version 47.0 only.
enableApprovalRequest	boolean	Indicates whether Approvals in Chatter are enabled for the org. When the value is `true`, 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 `false`, approval requests aren’t posted to Chatter. By default, the value is `false`. In Setup, enableApprovalRequest equates to the Chatter setting Allow Approvals.
enableCaseFeedRelativeTimestamps	boolean	In Case feeds, indicates whether to use relative (`true`) or absolute (`false`) date and time stamp formats on Case feed items. When the value is `true`, Case feed items show a relative time stamp (for example, `10m ago`). When the value is `false`, Case feed items show an absolute time stamp (for example, `January 7, 2020 at 12:15PM`). When you change this setting, all time stamps in Case feeds reflect that change. The default value is `true`. This field is available in API version 48.0 and later. In Setup, enableCaseFeedRelativeTimestamps equates to the Chatter setting Show relative timestamp.
enableChatter	boolean	Indicates whether Chatter is enabled for your org (`true`) or not (`false`).
enableChatterEmoticons	boolean	Indicates whether the automatic conversion of text characters, such as :), into a graphic emoticon is allowed in Chatter (`true`) or isn’t allowed (`false`). In Setup, enableChatter equates to the Chatter setting Allow Emoticons.
enableFeedEdit	boolean	Indicates whether qualified users can edit feed posts and comments (`true`) or not (`false`). Qualified users include: The author of the post or comment The person who owns the record that was posted to or commented on The Chatter or community moderator In Setup, enableFeedEdit equates to the Chatter setting Allow users to edit posts and comments.
enableFeedPinning	boolean	Indicates whether to allow the pinning of posts in a feed (true) or not (false). When set to true: Authorized users can pin posts to the top of the feed. The feed supports up to three pinned posts. Pinned posts stay pinned until they’re unpinned. 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. In Setup, enableFeedPinning equates to the Chatter setting Allow post pinning.
enableFeedsDraftPosts	boolean	Indicates whether draft posts are automatically saved every seven seconds (`true`) or not (`false`). When set to `true`: Adds the My Drafts feed to the Chatter tab Saves draft posts automatically every seven seconds Makes drafts available in the My Drafts feed When the user posts the entry, the draft is automatically removed from the My Drafts feed. In Setup, enableFeedsDraftPosts equates to the Chatter setting Allow draft posts.
enableFeedsRichText	boolean	Indicates whether to use the Rich Text Editor in the Chatter Publisher (`true`) or not (`false`). The rich text editor supports text formats, inline images, hyperlinks, and, when enabled for the org, code snippets. In Setup, enableFeedsRichText equates to the Chatter setting Allow users to compose rich text posts.
enableInviteCsnUsers	boolean	Indicates whether licensed users can invite customers to private groups that the licensed user owns or manages (`true`) or not (`false`). Licensed users can invite customers who are from outside org email domains. Invited customers can see information only in the groups they're invited to. They can interact only with members of those groups. In Setup, enableInviteCsnUsers equates to the Chatter setting Allow customer invitations.
enableOutOfOfficeEnabledPref	boolean	Indicates whether to add an Out of Office setting to a user profile page (`true`), or to omit it (`false`). When set to `true`, adds a control to user profile pages for setting a personal out-of-office message. In Setup, enableOutOfOfficeEnabledPref equates to the Chatter setting Users can set Out of Office message.
enableRichLinkPreviewsInFeed	boolean	Indicates whether to convert links in posts into embedded videos, images, and article previews (`true`) or not to convert the links (`false`). In Setup, enableRichLinkPreviewsInFeed equates to the Chatter setting Allow Rich Link Previews.
enableTodayRecsInFeed	boolean	Indicates whether to allow the posting of recommendations for using the Salesforce Today app in users’ feeds (`true`) or not (`false`). When set to `true`, automatically posts recommendations for using the Salesforce Today app in users’ feeds. In Setup, enableTodayRecsInFeed equates to the Chatter setting Allow Today Recommendations.
unlistedGroupsEnabled	boolean	Indicates whether to allow the creation of unlisted groups (`true`) or to prevent their creation (`false`). When set to `true`, users can create unlisted groups. Unlisted groups do not appear on the Groups list page. Membership in unlisted groups is by invitation only. In Setup, unlistedGroupsEnabled equates to the Chatter setting Enable Unlisted Groups.

Declarative Metadata Sample Definition

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

1<?xml version="1.0" encoding="UTF-8"?>
2 <ChatterSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3     <allowChatterGroupArchiving>true</allowChatterGroupArchiving>
4     <allowRecordsInChatterGroup>true</allowRecordsInChatterGroup>
5     <enableApprovalRequest>true</enableApprovalRequest>
6     <enableChatter>true</enableChatter>
7     <enableChatterEmoticons>true</enableChatterEmoticons>
8     <enableFeedEdit>true</enableFeedEdit>
9     <enableFeedsDraftPosts>false</enableFeedsDraftPosts>
10     <enableFeedsRichText>true</enableFeedsRichText>
11     <enableInviteCsnUsers>true</enableInviteCsnUsers>
12     <enableOutOfOfficeEnabledPref>false</enableOutOfOfficeEnabledPref>
13     <enableRichLinkPreviewsInFeed>true</enableRichLinkPreviewsInFeed>
14     <enableTodayRecsInFeed>true</enableTodayRecsInFeed>
15     <unlistedGroupsEnabled>true</unlistedGroupsEnabled>
16 </ChatterSettings>

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

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3    <types>
4        <members>Chatter</members>
5        <name>Settings</name>
6    </types>
7    <version>47.0</version>
8</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. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.