User Settings

Get information about a user’s global Chatter settings.
Resource
1/chatter/users/userId/settings
1/connect/communities/communityId/chatter/users/userId/settings

The userId must be the ID of the context user or the alias me.

Note

Available since version
27.0
Requires Chatter
Yes
HTTP methods
GET, HEAD, or PATCH
Request body for PATCH
Root XML tag
<userChatterSettings>
Properties
Name Type Description Available Version
defaultGroup​EmailFrequency String The default frequency with which a user receives email from a group when they join. Valid values are:
  • EachPost
  • DailyDigest
  • WeeklyDigest
  • Never
In communities, the Email on every post option is disabled after more than 10,000 members choose this setting for the group. All members who had this option selected are automatically switched to Daily digests.
27.0
Request parameter for PATCH
Parameter Name Type Description Available Since
defaultGroup​EmailFrequency String The default frequency with which a user receives email from a group when they join. This setting does not affect groups a user is already a member of. Valid values are:
  • EachPost
  • DailyDigest
  • WeeklyDigest
  • Never
27.0
Response body for GET, HEAD, or PATCH
User Chatter Settings
Response body example for GET
1{"defaultGroupEmailFrequency": "Never"}