---
schema_version: "1"
id: c37457320e9871703933fc821932db78e22ced37a8444289f2a42f70341165d7
title: Chatter Feeds Connect REST API
collection: developer
version: current
locale: en-us
portal_url: https://docs.salesforce.com/developer/current/en-us/connect-rest/connect-rest-api/references/generated-api-specs/connect-rest-api-chatter-feeds.md
canonical_url: https://developer.salesforce.com/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds
source_site: developer.salesforce.com
content_type: documentation
content_hash: c1020eae40293f9489f67eb8f65e776b5461edab15863037e4dd9346fe730482
products:
- Connect REST API Developer Guide
- Connect REST APIs
---
Chatter Feeds Connect REST API
# Chatter Feeds Connect REST API
> **Note**: The API Reference has a new three-panel layout. Browse grouped endpoints on the left, review endpoint details in the center, and access examples on the right.
These REST API resources require Chatter and have a per user, per application, per hour rate limit. This rate limit is different from other Connect REST API resources. When you exceed the rate limit, Chatter REST API resources return a 503 Service Unavailable error code.
**Important**: 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.
**Version:** v68.0
## Servers
* `https://{MyDomainName}.my.salesforce.com/services/data/v68.0` API server for your Salesforce org.
* ``MyDomainName (default None) Your org's My Domain name, which is used as a subdomain for the URLs that Salesforce uses to serve your org. For example, if your Lightning URL is `https://yourcompanyname.lightning.force.com`, then your My Domain name is `yourcompanyname`. Find your My Domain name and login URL on the My Domain page in Setup, or use the `getMyDomainName()` method in the Apex Domain class.``
## Tags
### Bookmarks Feed Resources
The bookmarks feed contains feed elements saved as bookmarks by the context user.
To bookmark an item, use PATCH with the [Feed Elements Capability, Bookmarks](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getBookmarksCapability) resource and the `isBookmarkedByCurrentUser` parameter. For example:
```
/chatter/feed-elements/0D5D0000000Ir6zKAC/capabilities/bookmarks?isBookmarkedByCurrentUser=true
```
### Comments Resources
Get information about, edit, like, upvote, verify, or delete a comment. Determine whether the context user can edit a comment.
### Company Feed Resources
The company feed contains all feed elements and comments from an entire company.
The company feed includes posts and comments from:
* People in the company, the ones a user follows and the ones a user doesn’t follow
* Public groups, including the ones a user is not a member of
* Private groups a user is a member of
* Updates for records and fields that an administrator configured for feed tracking, including the ones a user is not following. However, a user only sees updates for records they are allowed to access.
These resources are not available for communities.
### Direct Messages Feed Resources
Get the URL to the context user's direct messages feed and a page of feed elements. Get all the feed elements for the context user's direct messages.
### Draft Feed Resources
The draft feed contains all the feed elements from the context user's drafts.
### Experience Cloud Site Comments Moderation Resources
Get information about whether a user flagged a comment as inappropriate. Moderators can get the number of times members flagged a comment. Also, flag a comment as inappropriate or delete flags.
### Experience Cloud Site Direct Message Moderation Feed Resources
The Experience Cloud site direct message moderation feed contains direct messages that are flagged for moderation. This feed is available only to users with Moderate Experiences Chatter Messages permissions.
### Experience Cloud Site Home Feed Resources
The Experience Cloud site home feed contains all feed elements and comments from the Experience Cloud site home.
### Experience Cloud Site Moderation Feed Resources
The Experience Cloud site moderation feed contains feed elements and comments that have been flagged for moderation in an Experience Cloud site. This feed is available only to users with the Moderate Experiences Feeds permission.
### Favorites Feed Resources
The favorite feed contains favorites saved by the context user. Favorites are feed searches, list views, and topics that the context user has added as a Chatter favorite.
### Feed Elements Resources
Access, edit, post, search, and delete feed elements. Access a feed element's capabilities, including bundles and their feed elements.
### Feeds Resources
A list of all of the feeds the context user is able to view.
Each user may have a different set of feeds. Use this resource to determine what feeds are available. In addition, the different feeds may have unique labels as well as URLs. Use the given labels returned in this resource and avoid hard-coding any of these values.
### Files Feed Resources
The files feed contains all the feed elements that contain files posted by people or groups that the context user follows.
### Filter Feed Resources
The filter feed is the news feed filtered to contain feed elements whose parent is a specified object type.
### Groups Feed Resources
The groups feed contains all feed elements from all groups the context user either owns or is a member of.
### Isolated Feed Resources
The isolated feed contains feed elements and comments that are isolated. Isolated feed elements and comments are available only to admins.
### Landing Feed Resources
Get information about the landing feed and a page of feed elements.
### Mute Feed Resources
The mute feed contains feed elements that the context user muted.
### News Feed Resources
The news feed contains feed elements of interest to the context user. You can post feed items to the news feed.
**Note**: To match the feed displayed in the Chatter UI, the composition of this feed may change between releases.
### Pending Review Feed Resources
The pending review feed contains feed elements and comments that are pending review.
### People Feed Resources
The people feed contains all feed elements posted by all people the context user follows.
### Record Feed Resources
The feed of the specified record, which could be a group, person, object, file and so on. You can post feed items to the record feed. You can get another user’s record feed.
### Streams Feed Resources
The streams feed contains all feed elements from any combination of up to 25 people, groups, records, and topics that the context user subscribes to in the stream.
### To Feed Resources
The to feed contains all @mentions of the context user and posts others have made to the context user's feed.
### Topics Feed Resources
The topics feed contains all the feed elements for a topic.
### User Profile Feed Resources
The user profile feed contains feed elements created by the user, parented by the user, and where the user is mentioned. In Experience Cloud sites only, this feed also contains feed elements on which the user commented. This feed is different than the news feed, which returns more feed items, including group updates. You can post to the user profile feed. You can get another user's user profile feed.
**Note**: To match the feed displayed in the Chatter UI, the composition of this feed may change between releases.
## Operations
### GET Comments, Batch
`GET /chatter/comments/batch/{commentIds}`
Operation ID: `getCommentBatch`. Tags: Comments Resources.
Returns information about comments in batch.
Get information about a comma-separated list of up to 100 comments.
_Available in: v42.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/batch/{commentIds}`
_Available in: v42.0_
#### Parameters
* `commentIds` (path, array of string (Id), required) Comma-separated list of up to 100 comment IDs.
#### Responses
* **200** _Batch Results_ Batch results.
Media type: `application/json`. Schema: `Batch`.
### GET Comment
`GET /chatter/comments/{commentId}`
Operation ID: `getComment`. Tags: Comments Resources.
Returns information about the specified comment. Also used to delete a comment.
Get information about a comment.
To post a comment, use [Feed Elements Capability, Comments Items](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getCommentsCapabilityItems).
_Available in: v23.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}`
_Available in: v23.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
#### Responses
* **200** _Comment_ A comment.
Media type: `application/json`. Schema: `Comment`.
### DELETE Comment
`DELETE /chatter/comments/{commentId}`
Operation ID: `deleteComment`. Tags: Comments Resources.
Returns information about the specified comment. Also used to delete a comment.
Delete a comment.
To post a comment, use [Feed Elements Capability, Comments Items](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getCommentsCapabilityItems).
_Available in: v23.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}`
_Available in: v23.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
#### Responses
* **204** _Successful Delete_ Success
### PATCH Comment
`PATCH /chatter/comments/{commentId}`
Operation ID: `patchComment`. Tags: Comments Resources.
Returns information about the specified comment. Also used to delete a comment.
Edit a comment.
To post a comment, use [Feed Elements Capability, Comments Items](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getCommentsCapabilityItems).
**Note**: PATCH can’t be used to update a comment’s capabilities.
_Available in: v34.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}`
_Available in: v34.0_
Returns the same response body as the [GET /chatter/comments/{commentId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/getComment) operation. See that operation for the full response schema.
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
#### Request body
Media type: `application/json`. Schema: `CommentInput`.
#### Responses
* **200** _Comment_ A comment.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/comments/{commentId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/getComment) operation. See that operation for the full response schema.
### GET Comments Capability, Threaded Comments
`GET /chatter/comments/{commentId}/capabilities/comments`
Operation ID: `getThreadedCommentsCapability`. Tags: Comments Resources.
Used to access the comments capability for a specific feed comment.
Access the comments capability for a comment.
If the comment doesn’t support this capability, the response is 404: Not Found.
_Available in: v44.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/capabilities/comments`
_Available in: v44.0_
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}/capabilities/comments](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getCommentsCapability) operation. See that operation for the full response schema.
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `threadedCommentsCollapsed` (query, boolean)
Specifies whether to return threaded comments in a collapsed style (`true`) or not (`false`). If you don’t specify a value, the default is `false`.
_Available in: v44.0_
#### Responses
* **200** _Comments Capability_ Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}/capabilities/comments](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getCommentsCapability) operation. See that operation for the full response schema.
### GET Comments Capability, Threaded Comments Items
`GET /chatter/comments/{commentId}/capabilities/comments/items`
Operation ID: `getThreadedCommentsCapabilityItems`. Tags: Comments Resources.
Returns information about comment tha re direct desendant for the specified comment.
Get threaded comments for a comment.
If the comment doesn’t support the `comments` capability, the response is 404: Not Found.
_Available in: v44.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/capabilities/comments/items`
_Available in: v44.0_
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}/capabilities/comments/items](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getCommentsCapabilityItems) operation. See that operation for the full response schema.
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `page` (query, string)
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response, such as `currentPageToken` or `nextPageToken`. If you don’t specify a value, the first page is returned.
_Available in: v43.0_
* `pageSize` (query, integer)
Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25.
_Available in: v43.0_
#### Responses
* **200** _Comment Page_ Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}/capabilities/comments/items](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getCommentsCapabilityItems) operation. See that operation for the full response schema.
### GET Comment Capability, Editability
`GET /chatter/comments/{commentId}/capabilities/edit/is-editable-by-me`
Operation ID: `getCommentEditCapabilityIsEditableByMe`. Tags: Comments Resources.
Used to determine if the context user can edit the comment.
Determines whether the context user can edit a comment.
If the comment doesn’t support this capability, the response is 404: Not Found.
_Available in: v34.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/capabilities/edit/is-editable-by-me`
_Available in: v34.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
#### Responses
* **200** _Feed Entity Is Editable_ Indicates whether the context user can edit a feed element or comment.
Media type: `application/json`. Schema: `FeedEntityIsEditable`.
### GET Comment Capability, Status
`GET /chatter/comments/{commentId}/capabilities/status`
Operation ID: `getCommentStatusCapability`. Tags: Comments Resources.
Access the status capability of a comment or set the status of a comment.
Access the status capability of a comment.
If the comment doesn’t support this capability, the response is 404: Not Found.
_Available in: v38.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/capabilities/status`
_Available in: v38.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
#### Responses
* **200** _Status Capability_ If a feed post or comment has this capability, it has a status that determines its visibility.
Media type: `application/json`. Schema: `StatusCapability`.
### PATCH Comment Capability, Status
`PATCH /chatter/comments/{commentId}/capabilities/status`
Operation ID: `patchCommentStatusCapability`. Tags: Comments Resources.
Access the status capability of a comment or set the status of a comment.
Set the status of a comment.
If the comment doesn’t support this capability, the response is 404: Not Found.
_Available in: v38.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/capabilities/status`
_Available in: v38.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `feedEntityStatus` (query, ConnectFeedEntityStatusEnum)
Status of the feed post or comment. Values are:
* `Draft` — The feed post isn’t published but is visible to the author and users with Modify All Data or View All Data permission. Comments can’t be drafts.
* `Isolated` — The feed post or comment is isolated, and only admins can see it.
* `PendingReview` — The feed post or comment isn’t approved yet and therefore isn’t published or visible.
* `Published` — The feed post or comment is approved and visible.
You must specify `feedEntityStatus` in a query parameter or a request body schema.
_Available in: v38.0_
#### Request body
_Available in: v38.0_
Media type: `application/json`. Schema: `StatusCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"feedEntityStatus": "Published"
}
```
#### Responses
* **200** _Status Capability_ If a feed post or comment has this capability, it has a status that determines its visibility.
Media type: `application/json`. Schema: `StatusCapability`.
### GET Comment Capability, Upvote and Downvote
`GET /chatter/comments/{commentId}/capabilities/up-down-vote`
Operation ID: `getCommentUpDownVoteCapability`. Tags: Comments Resources.
Used to get or delete up down vote of a comment.
Get the upvotes and downvotes for a comment.
If the comment doesn’t support this capability, the response is 404: Not Found.
_Available in: v41.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/capabilities/up-down-vote`
_Available in: v41.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
#### Responses
* **200** _Up Down Vote Capability_ If a feed post or comment has this capability, users can upvote or downvote it.
Media type: `application/json`. Schema: `UpDownVoteCapability`.
### PATCH Comment Capability, Upvote and Downvote
`PATCH /chatter/comments/{commentId}/capabilities/up-down-vote`
Operation ID: `patchCommentUpDownVoteCapability`. Tags: Comments Resources.
Used to get or delete up down vote of a comment.
Upvote or downvote a comment.
If the comment doesn’t support this capability, the response is 404: Not Found.
_Available in: v41.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/capabilities/up-down-vote`
_Available in: v41.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `vote` (query, ConnectUpDownVoteValueEnum)
Type of vote for a feed element or comment.
You must specify `vote` in a query parameter or a request body schema.
_Available in: v41.0_
#### Request body
Upvote or downvote a feed element or a comment.
_Available in: v41.0_
Media type: `application/json`. Schema: `UpDownVoteCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"vote": "Up"
}
```
#### Responses
* **200** _Up Down Vote Capability_ If a feed post or comment has this capability, users can upvote or downvote it.
Media type: `application/json`. Schema: `UpDownVoteCapability`.
### GET Comment Capability, Upvote and Downvote Items
`GET /chatter/comments/{commentId}/capabilities/up-down-vote/items`
Operation ID: `getCommentUpDownVoteCapabilityItems`. Tags: Comments Resources.
Used to access a page of up or down votes for a specific comment.
Get a list of users who upvoted or downvoted a comment.
If the comment doesn’t support this capability, the response is 404: Not Found.
_Available in: v42.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/capabilities/up-down-vote/items`
_Available in: v42.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `page` (query, integer)
Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.
_Available in: v42.0_
* `pageSize` (query, integer)
Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25.
_Available in: v42.0_
* `vote` (query, ConnectUpDownVoteValueEnum, required)
Specifies the value of the vote for the feed element.
You can’t specify `None`.
_Available in: v42.0_
#### Responses
* **200** _Vote Collection_ A collection of upvotes or downvotes for a feed element or comment.
Media type: `application/json`. Schema: `VoteCollection`.
### GET Comment Capability, Verified
`GET /chatter/comments/{commentId}/capabilities/verified`
Operation ID: `getCommentVerifiedCapability`. Tags: Comments Resources.
Used to get or set the verified status of a comment.
Get the verified status of a comment.
If the comment doesn’t support this capability, the response is 404: Not Found.
_Available in: v41.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/capabilities/verified`
_Available in: v41.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
#### Responses
* **200** _Verified Capability_ If a comment has this capability, users with permission can mark it as verified or unverified.
Media type: `application/json`. Schema: `VerifiedCapability`.
### PATCH Comment Capability, Verified
`PATCH /chatter/comments/{commentId}/capabilities/verified`
Operation ID: `patchCommentVerifiedCapability`. Tags: Comments Resources.
Used to get or set the verified status of a comment.
Mark a comment as verified or unverified.
If the comment doesn’t support this capability, the response is 404: Not Found.
_Available in: v41.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/capabilities/verified`
_Available in: v41.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `isVerified` (query, boolean)
Specifies whether to mark the comment as verified (`true`) or unverified (`false`).
Only verified comments can be marked as unverified, and only unverified comments can be marked as verified.
You must specify `isVerified` in a query parameter or a request body schema.
_Available in: v41.0_
* `isVerifiedByAnonymized` (query, boolean)
Specifies whether to mark the comment as verified by an anonymous user (`true`).
If a user previously verified a comment and then requested the activity to be deleted, use `isVerifiedByAnonymized` to maintain the verification and anonymize the value of `lastVerifiedByUser`.
You can’t set `isVerified` and `isVerifiedByAnonymized` to `true` at the same time. `isVerifiedByAnonymized` can be set to `true` only if `isVerified` is already set to `true`.
You can’t set `isVerifiedByAnonymized` to `false`. After `isVerifiedByAnonymized` is set to `true`, it can be undone only when another user marks the comment as unverified and then reverifies the comment.
_Available in: v43.0_
#### Request body
_Available in: v41.0_
Media type: `application/json`. Schema: `VerifiedCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"isVerified": "true"
}
```
#### Responses
* **200** _Verified Capability_ If a comment has this capability, users with permission can mark it as verified or unverified.
Media type: `application/json`. Schema: `VerifiedCapability`.
### GET Comment Likes
`GET /chatter/comments/{commentId}/likes`
Operation ID: `getCommentLikeCollection`. Tags: Comments Resources.
Returns information about the likes for the specified comment. Also used to add a like to a comment.
Get information about the likes for a comment.
_Available in: v23.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/likes`
_Available in: v23.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `page` (query, integer) Specifies the number of the page you want returned.
* `pageSize` (query, integer) Specifies the number of items per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.
#### Responses
* **200** _Like Page_ Page of Chatter likes.
Media type: `application/json`. Schema: `LikePage`.
### POST Comment Likes
`POST /chatter/comments/{commentId}/likes`
Operation ID: `postCommentLikeCollection`. Tags: Comments Resources.
Returns information about the likes for the specified comment. Also used to add a like to a comment.
Like a comment.
**Note**: POST doesn’t take request parameters or a request body.
_Available in: v23.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/likes`
_Available in: v23.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
#### Responses
* **200** _Like_ Chatter like.
Media type: `application/json`. Schema: `Like`.
### PATCH Comment Likes
`PATCH /chatter/comments/{commentId}/likes`
Operation ID: `patchCommentLikeCollection`. Tags: Comments Resources.
Returns information about the likes for the specified comment. Also used to add a like to a comment.
Like or unlike a comment.
_Available in: v39.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/likes`
_Available in: v39.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `isLikedByCurrentUser` (query, boolean, required)
Specifies whether the context user likes ( `true` ) or unlikes ( `false` ) the comment.
_Available in: v39.0_
#### Responses
* **200** _Like Page_ Page of Chatter likes.
Media type: `application/json`. Schema: `LikePage`.
### GET Threaded Comment
`GET /chatter/comments/{commentId}/thread-context`
Operation ID: `getThreadedCommentsDeepLink`. Tags: Comments Resources.
Fetching comment in context view for ThreadedComments Deep Linking behavior for a specified comment.
Get a threaded comment in context of its parent comments and post.
If the comment doesn’t support the `comments` capability, the response is 404: Not Found.
_Available in: v44.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/comments/{commentId}/thread-context`
_Available in: v44.0_
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation. See that operation for the full response schema.
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `pageSize` (query, integer)
Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25.
_Available in: v44.0_
#### Responses
* **200** _Feed Item_ Returns the feed element that provides the context for the thread. The response body is a Feed Item.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation. See that operation for the full response schema.
### GET Feed Elements, Search
`GET /chatter/feed-elements`
Operation ID: `getFeedElementCollection`. Tags: Feed Elements Resources.
Post a feed element or search all feed elements in the organization.
Search all feed elements in an org.
_Available in: v31.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements`
_Available in: v31.0_
#### Parameters
* `page` (query, string)
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in `null`, the default size is 25.
_Available in: v31.0_
* `q` (query, string, required)
One or more keywords to search for in the feed elements visible to the context user. The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to return with each feed element. The default value is 3.
_Available in: v31.0_
* `sort` (query, ConnectFeedSortOrder)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` — Sorts by most recent creation date.
* `LastModifiedDateDesc` — Sorts by most recent activity.
* `MostViewed` — Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` — Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
_Available in: v31.0_
* `threadedCommentsCollapsed` (query, boolean)
Specifies whether to return threaded comments in a collapsed style (`true`) or not (`false`). If you don’t specify, the default is `false`.
_Available in: v44.0_
#### Responses
* **200** _Feed Element Page_ Success
Media type: `application/json`. Schema: `FeedElementPage`.
#### Code samples
_Example: Example 1 · HTTP_
```
/chatter/feed-elements?feedElementType=FeedItem&subjectId=0F9B000000000W2&text=New+post
```
_Example: Example 2 · HTTP_
```
/chatter/feed-elements?q=track
```
### POST Feed Elements
`POST /chatter/feed-elements`
Operation ID: `postFeedElementCollection`. Tags: Feed Elements Resources.
Post a feed element or search all feed elements in the organization.
Post feed elements.
_Available in: v31.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation. See that operation for the full response schema.
#### Parameters
* `feedElementType` (query, ConnectFeedElementTypeEnum, required)
Feed elements are the top-level items that a feed contains. Feeds are feed element containers.
The only possible value is `FeedItem`.
_Available in: v31.0_
* `subjectId` (query, string, required)
The ID of the parent this feed element is being posted to. This value can be the ID of a user, group, or record, or the string `me` to indicate the context user.
_Available in: v31.0_
* `text` (query, string, required)
Text of the feed element.
_Available in: v31.0_
* `visibility` (query, ConnectFeedItemVisibilityEnum)
Specifies the type of users who can see a feed element.
* `AllUsers` — Visibility is not limited to internal users.
* `InternalUsers` — Visibility is limited to internal users.
_Available in: v31.0_
#### Request body
Feed item input.
_Available in: v31.0_
Media type: `multipart/form-data`. Schema: `object`.
* `attachment` (_string_)
You can specify only one of these values in the attachment parameter. Values are:
* Attachment Input: Canvas App (v29.0–31.0)
* Attachment Input: Existing Content (v23.0–31.0)
* Attachment Input: Feed Poll (v26.0–31.0)
* Attachment Input: Link (v23.0–31.0)
* Attachment Input: New File Upload (v23.0–31.0)
**Important**: As of API version 32.0, use the `capabilities` property.
* `body` (_string_)
Description of message body. Feed item and comment bodies have a 10,000 character limit. Because this limit can change, we recommend that clients make a `describeSObjects()` call on the FeedItem or FeedComment object. To determine the maximum number of allowed characters, look at the length of the Body or CommentBody field. The body can contain up to 25 mentions.
If you specify `originalFeedElementId` to share a feed item, use the `body` property to add the first comment to the feed item.
To edit this property in a feed item, make a PATCH request to `/chatter/feed-elements/{feedElementId}`. Editing feed posts is supported in version 34.0 and later.
Required unless the feed item has a content capability or a link capability
_Available in: v23.0_
* `capabilities` (_object_)
FeedElementCapabilitySetInput
The capabilities that define the behavior of this feed element.
_Available in: v31.0_
Includes all fields of `FeedElementCapabilitySetInput`.
* `isBookmarkedByCurrentUser` (_boolean_)
Specifies whether to bookmark the new feed item for the user (`true`) or not (`false`). The default value is `false`.
**Important**: As of API version 32.0, use the `capabilities.bookmarks.isBookmarkedByCurrentUser` property.
_Available in: v24.0–31.0_
* `feedElementType` (_string_)
The type of feed element this input represents.
The only valid value is `FeedItem`.
Required when creating a feed item (POST). Optional when updating a feed item (PATCH)
_Available in: v31.0_
* `originalFeedElementId` (_string_)
To share a feed element, specify its 18-character ID .
You can’t share a post and upload a file in the same request body.
In API version 39.0 and later, use the `capabilities.feedEntityShare.feedEntityId` property.
_Available in: v31.0–38.0_
* `originalFeedItemId` (_string_)
To share a feed item, specify its 18-character ID .
In API version 32.0–38.0, use the `originalFeedElementId` property. In API version 39.0 and later, use the `capabilities.feedEntityShare.feedEntityId` property.
_Available in: v24.0–31.0_
* `subjectId` (_string_)
The ID of the parent this feed element is being posted to. This value can be the ID of a user, group, or record, or the string `me` to indicate the context user.
In version 45.0 and later, you can move a feed element from one public group to another by setting this property to the ID of the new public group. You can’t include or change any other properties when moving a feed element.
_Available in: v31.0_
* `visibility` (_string_)
Who can see the post. Valid values are:
* `InternalUsers` — If digital experiences is enabled, only members of the default, internal site can see the feed item.
* `AllUsers` — If digital experiences is enabled, all members of the site can see the feed item.
Default values:
* For external users, the default value is `AllUsers`. External users must use this value to see their posts.
* For internal users, the default value is `InternalUsers`. Internal users can accept this value or use the value `AllUsers` to allow external users to see their posts.
If the parent of the feed item is a user, group, or direct message, the `visibility` of the feed item must be `AllUsers`.
_Available in: v26.0_
_Example: example\_1_ Payload 1
The following example attaches a poll to a feed item:
```
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
#### Responses
* **200** _Feed Item_ Returns the posted feed element. The response body is a Feed Item.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation. See that operation for the full response schema.
#### Code samples
_Example: Example 1 · HTTP_
```
/chatter/feed-elements?feedElementType=FeedItem&subjectId=0F9B000000000W2&text=New+post
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 2 · HTTP_
```
/chatter/feed-elements?q=track
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 3 · HTTP_
```
{
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning? "
}]
},
"feedElementType" : "FeedItem",
"subjectId" : "005D00000016Qxp"
}
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 4 · HTTP_
```
{
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning? "
},
{
"type" : "Mention",
"id" : "005T0000000mzCy"
}
]
},
"feedElementType" : "FeedItem",
"subjectId" : "005D00000016Qxp"
}
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 5 · HTTP_
```
{
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning? "
},
{
"type" : "Mention",
"id" : "005T0000000mzCy"
},
{
"type" : "Text",
"text" : " "
},
{
"type" : "Mention",
"id" : "005B0000000Ek1S"
}
]
},
"feedElementType" : "FeedItem",
"subjectId" : "005D00000016Qxp"
}
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 6 · HTTP_
```
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Please take a look at these files."
}
]
},
"capabilities":{
"files":{
"items": [
{"id": "069D00000001IOh"},
{"id": "069D00000002IOg"}
]
}
},
"subjectId":"me",
"feedElementType":"FeedItem"
}
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 7 · HTTP_
```
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"When should we meet for release planning?"
}
]
},
"capabilities":{
"poll":{
"choices":[
"Monday",
"Tuesday"
]
}
},
"feedElementType":"FeedItem",
"subjectId":"me"
}
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 8 · HTTP_
```
{
"body":{
"messageSegments":[
{
"markupType" : "Paragraph",
"type" : "MarkupBegin"
},
{
"markupType" : "Bold",
"type" : "MarkupBegin"
},
{
"text" : "First line of text.",
"type" : "Text"
},
{
"markupType" : "Bold",
"type" : "MarkupEnd"
},
{
"markupType" : "Paragraph",
"type" : "MarkupEnd"
},
{
"markupType" : "Paragraph",
"type" : "MarkupBegin"
},
{
"text" : " ",
"type" : "Text"
},
{
"markupType" : "Paragraph",
"type" : "MarkupEnd"
},
{
"markupType" : "Paragraph",
"type" : "MarkupBegin"
},
{
"text" : "Second line of text.",
"type" : "Text"
},
{
"markupType" : "Paragraph",
"type" : "MarkupEnd"
}
]
},
"subjectId":"me",
"feedElementType":"FeedItem"
}
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 9 · HTTP_
```
{
"body":{
"messageSegments":[
{
"markupType" : "Code",
"type" : "MarkupBegin"
},
{
"text" : "",
"type" : "Text"
},
{
"markupType" : "Code",
"type" : "MarkupEnd"
}
]
},
"subjectId":"me",
"feedElementType":"FeedItem"
}
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 10 · HTTP_
```
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Please take a look at this file."
},
{
"type":"InlineImage",
"fileId":"069xx00000000QO",
"altText":"API Spec"
},
{
"type":"Text",
"text":"And this one."
},
{
"type":"InlineImage",
"fileId":"069xx00000000QT",
"altText":"REST API Spec"
}
]
},
"subjectId":"me",
"feedElementType":"FeedItem"
}
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 11 · HTTP_
```
{
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning? "
},
{
"type" : "Mention",
"id" : "005D00000016Qxp"
}]
},
"capabilities" : {
"feedEntityShare" : {
"feedEntityId" : "0D5B000000Py41t"
}
},
"feedElementType" : "FeedItem",
"subjectId" : "0F9B000000000W2"
}
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
_Example: Example 12 · HTTP_
```
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Thanks for attending my presentation test run this morning. Send me any feedback."
}
]
},
"capabilities":{
"directMessage":{
"membersToAdd": ["005R0000000I2X4","005R0000000I23Y"],
"subject": "Thank you!"
}
},
"subjectId":"me",
"feedElementType":"FeedItem"
}
Content-Type: application/json
{
"body": {
"messageSegments": [
{
"type": "Text",
"text": "When should we meet for release planning?"
}
]
},
"capabilities": {
"poll": {
"choices": [
"Monday",
"Tuesday"
]
}
},
"feedElementType": "FeedItem",
"subjectId": "me"
}
```
### POST Feed Elements, Batch
`POST /chatter/feed-elements/batch`
Operation ID: `postFeedElementBatchCollection`. Tags: Feed Elements Resources.
Allows batch posting of feed elements.
Post a batch of up to 500 feed elements.
_Available in: v32.0_
#### Post a batch of feed elements
This example uses the `/chatter/feed-elements/batch` resource to post a batch of feed elements. This example uses cURL.
```
curl -H "X-PrettyPrint: 1" -F 'json={"inputs":[{"richInput":{"subjectId":"me","body":{"messageSegments":[{"type":"Text","text":"Post Number 1"}]},"feedElementType":"FeedItem"}},{"richInput":{"subjectId":"me","body":{"messageSegments":[{"type":"Text","text":"Post Number 2"}]},"feedElementType":"FeedItem"}}]};type=application/json' -X POST https://
```
Here’s the same example showing just the request body:
```
{
"inputs": [
{
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 1"
}
]
},
"feedElementType": "FeedItem"
}
},
{
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 2"
}
]
},
"feedElementType": "FeedItem"
}
}
]
}
```
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/batch`
_Available in: v32.0_
#### Request body
Describes a collection of inputs for a batch request.
Media type: `application/json`. Schema: `object`.
* `inputs` (_array of object_, required)
Collection of inputs (request bodies) to be processed together. Every Batch Input request body’s `richInput` property must contain the same type of request body.
_Available in: v32.0_
* `richInput` (_AbstractFeedElementInput_)
_Example: example\_1_ Payload 1
```
{
"inputs": [
{
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 1"
}
]
},
"feedElementType": "FeedItem"
}
},
{
"richInput": {
"subjectId": "me",
"body": {
"messageSegments": [
{
"type": "Text",
"text": "Post Number 2"
}
]
},
"feedElementType": "FeedItem"
}
}
]
}
```
#### Responses
* **200** _Batch Results_
Batch results.
The Batch Results response body contains Feed Item response bodies corresponding to each of the request bodies. The Feed Item response bodies are returned in the same order as the request bodies.
The request returns an HTTP 200 status code unless an error occurs that affects the entire request (such as a parsing failure). If an individual request body causes an error, the Batch Results Item `statusCode` property contains the appropriate HTTP status code.
Media type: `application/json`. Schema: `Batch`.
### GET Feed Elements, Batch
`GET /chatter/feed-elements/batch/{feedElementIds}`
Operation ID: `getFeedElementBatch`. Tags: Feed Elements Resources.
Returns information about more than one feed element at the same time.
Get information about a comma-separated list of up to 500 feed elements. Errors for feed elements that can’t be loaded are returned in the results.
_Available in: v31.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/batch/{feedElementIds}`
_Available in: v31.0_
#### Parameters
* `feedElementIds` (path, array of string (Id), required) Comma-separated list of up to 500 feed element IDs.
#### Responses
* **200** _Batch Results_ Batch results.
Media type: `application/json`. Schema: `Batch`.
### PATCH Feed Elements Capability, Batch Update Read By
`PATCH /chatter/feed-elements/batch/{feedElementIds}/capabilities/read-by`
Operation ID: `patchFeedElementReadByCapabilityBatch`. Tags: Feed Elements Resources.
Sets read status more than one feed element at the same time.
Mark multiple feed elements as read by the context user at the same time.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v40.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/batch/{feedElementIds}/capabilities/read-by`
_Available in: v40.0_
#### Parameters
* `feedElementIds` (path, array of string (Id), required) Comma-separated list of feed element IDs.
* `isReadByMe` (query, boolean)
Specifies to mark the feed element as read (`true`) for the context user.
You must specify `isReadByMe` in a query parameter or a request body.
_Available in: v40.0_
#### Request body
Mark feed elements as read by the context user.
_Available in: v40.0_
Media type: `application/json`. Schema: `ReadByCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"isReadByMe": "true"
}
```
#### Responses
* **200** _Batch Results_ Batch results.
Media type: `application/json`. Schema: `Batch`.
### POST Draft Feed Element
`POST /chatter/feed-elements/publish-draft`
Operation ID: `postFeedElementPublishDraft`. Tags: Feed Elements Resources.
Used to publish a specific draft feed element.
Publish a draft feed element.
_Available in: v44.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/publish-draft`
_Available in: v44.0_
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation. See that operation for the full response schema.
#### Parameters
* `feedElementId` (query, string, required)
ID of the draft feed element to publish.
If you don’t need to update your draft prior to publishing, use this request parameter.
_Available in: v44.0_
#### Request body
If you want to update your draft prior to publishing, use the Feed Item Input request body.
Feed item input.
**Note**: Use the `feedElementId` request parameter in addition to the Feed Item Input request body.
_Available in: v44.0_
Media type: `application/json`. Schema: `AbstractFeedElementInput`.
_Example example\_1: same as POST /chatter/feed-elements request._ Payload 1
The following example attaches a poll to a feed item:
_Example: example\_1_ Payload 1
The following example attaches a poll to a feed item:
#### Responses
* **200** _Feed Item_
Returns the published feed element. The response body is a Feed Item. (A feed item is a type of feed element.)
The published feed item has a new ID.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation. See that operation for the full response schema.
### GET Feed Element
`GET /chatter/feed-elements/{feedElementId}`
Operation ID: `getFeedElement`. Tags: Feed Elements Resources.
Used to access, update or delete a specific feed element.
Get a feed element.
_Available in: v31.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}`
_Available in: v31.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `commentSort` (query, ConnectFeedCommentSortOrder)
Order of comments. Values are:
* `CreatedDateLatestAsc` — Sorts by most recently created comments in ascending order.
* `CreatedDateOldestAsc` — Sorts by oldest comments in ascending order.
* `Relevance` — Sorts by most relevant content.
The default value is `CreatedDateLatestAsc`.
Sorting in descending order isn’t supported.
_Available in: v41.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to return with each feed element. The default value is 3.
_Available in: v31.0_
* `threadedCommentsCollapsed` (query, boolean)
Specifies whether to return threaded comments in a collapsed style (`true`) or not (`false`). If you don’t specify, the default is `false`.
_Available in: v44.0_
#### Responses
* **200** _Generic Feed Element_ Returns the requested feed element. The response body is a Generic Feed Element or a Feed Item.
Media type: `application/json`. Schema: `AbstractFeedElement`.
### DELETE Feed Element
`DELETE /chatter/feed-elements/{feedElementId}`
Operation ID: `deleteFeedElement`. Tags: Feed Elements Resources.
Used to access, update or delete a specific feed element.
Delete a feed element.
_Available in: v31.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}`
_Available in: v31.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **204** _Successful Delete_ Success
### PATCH Feed Element
`PATCH /chatter/feed-elements/{feedElementId}`
Operation ID: `patchFeedElement`. Tags: Feed Elements Resources.
Used to access, update or delete a specific feed element.
Edit a feed element. Feed items are the only type of feed element that can be edited.
_Available in: v34.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}`
_Available in: v34.0_
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation. See that operation for the full response schema.
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Request body
Feed item input.
Media type: `application/json`. Schema: `AbstractFeedElementInput`.
_Example example\_1: same as POST /chatter/feed-elements request._ Payload 1
The following example attaches a poll to a feed item:
_Example: example\_1_ Payload 1
The following example attaches a poll to a feed item:
#### Responses
* **200** _Feed Item_ Returns the feed element. The response body is a Feed Item. (A feed item is a type of feed element.)
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation. See that operation for the full response schema.
### GET Feed Elements Capabilities
`GET /chatter/feed-elements/{feedElementId}/capabilities`
Operation ID: `getFeedElementCapabilities`. Tags: Feed Elements Resources.
Used to access a specific feed element's set of capabilities.
Access a feed element's set of capabilities.
_Available in: v31.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities`
_Available in: v31.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to return with each feed element. The default value is 3.
_Available in: v31.0_
#### Responses
* **200** _Feed Element Capabilities_
A container for all capabilities that can be included with a feed element.
In API version 30.0 and earlier, most feed items can have comments, likes, topics, and so on. In version 31.0 and later, every feed item (and feed element) can have a unique set of capabilities. If a capability property exists on a feed element, that capability is available, even if the capability property doesn’t have a value. For example, if the `ChatterLikes` capability property exists on a feed element (with or without a value), the context user can like that feed element. If the capability property doesn’t exist, it isn’t possible to like that feed element. A capability can also contain associated data. For example, the `Moderation` capability contains data about moderation flags.
Media type: `application/json`. Schema: `FeedElementCapabilitySet`.
### GET Feed Elements Capability, Bookmarks
`GET /chatter/feed-elements/{feedElementId}/capabilities/bookmarks`
Operation ID: `getBookmarksCapability`. Tags: Feed Elements Resources.
Used to access bookmarks for a specific feed element, or to add a bookmark to a specific feed element.
Get information about whether a feed element is bookmarked.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/bookmarks`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Bookmarks Capability_ If a feed element has this capability, the context user can bookmark it.
Media type: `application/json`. Schema: `BookmarksCapability`.
### PATCH Feed Elements Capability, Bookmarks
`PATCH /chatter/feed-elements/{feedElementId}/capabilities/bookmarks`
Operation ID: `patchBookmarksCapability`. Tags: Feed Elements Resources.
Used to access bookmarks for a specific feed element, or to add a bookmark to a specific feed element.
Add bookmarks to feed elements.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/bookmarks`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `isBookmarkedByCurrentUser` (query, boolean)
Specifies if the feed element should be bookmarked for the user (`true`) or not (`false`).
You must specify `isBookmarkedByCurrentUser` in a query parameter or a request body.
_Available in: v32.0_
#### Request body
_Available in: v32.0_
Media type: `application/json`. Schema: `BookmarksCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"isBookmarkedByCurrentUser": true
}
```
#### Responses
* **200** _Bookmarks Capability_ If a feed element has this capability, the context user can bookmark it.
Media type: `application/json`. Schema: `BookmarksCapability`.
#### Code samples
_Example: Example 1 · HTTP_
```
{
"isBookmarkedByCurrentUser": true
}
```
### GET Feed Elements Capability, Bundle
`GET /chatter/feed-elements/{feedElementId}/capabilities/bundle`
Operation ID: `getFeedElementBundleCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's bundle capability.
Access the bundle capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v31.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/bundle`
_Available in: v31.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to return with each feed element. The default value is 3.
_Available in: v31.0_
#### Responses
* **200** _Generic Bundle Capability_
If a feed element has this capability, the feed element may be a group of other feed elements condensed into one.
**Note**: Bundled posts contain feed-tracked changes and are in record feeds only.
Media type: `application/json`. Schema: `AbstractBundleCapability`.
### GET Feed Elements Capability, Bundle Elements
`GET /chatter/feed-elements/{feedElementId}/capabilities/bundle/feed-elements`
Operation ID: `getFeedElementBundleFeed`. Tags: Feed Elements Resources.
Returns all feed elements that are grouped together in a bundle.
Access all feed elements that are grouped together in a bundle.
Bundled posts contain feed-tracked changes and are in record feeds only.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v31.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/bundle/feed-elements`
_Available in: v31.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
_Available in: v31.0_
* `page` (query, string)
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in `null`, the default size is 25.
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to return with each feed element. The default value is 3.
_Available in: v31.0_
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `FeedElementPage`.
### GET Feed Elements Capability, Chatter Likes
`GET /chatter/feed-elements/{feedElementId}/capabilities/chatter-likes`
Operation ID: `getChatterLikesCapability`. Tags: Feed Elements Resources.
Used to access likes for a specific feed element.
Access information about the chatter likes capability for a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/chatter-likes`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `ChatterLikesCapability`.
### GET Feed Elements Capability, Chatter Likes Items
`GET /chatter/feed-elements/{feedElementId}/capabilities/chatter-likes/items`
Operation ID: `getChatterLikesCapabilityItems`. Tags: Feed Elements Resources.
Used to access a page of likes for a specific feed element, or to add a like to a specific feed element.
Access a page of likes for a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/chatter-likes/items`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `page` (query, integer)
Specifies the number of the page you want returned. If you don’t specify a value, the first page is returned.
_Available in: v32.0_
* `pageSize` (query, integer)
Specifies the number of likes per page. Valid values are from 1 to 100. If you don't specify a size, the default is 25.
_Available in: v32.0_
#### Responses
* **200** _Like Page_ Page of Chatter likes.
Media type: `application/json`. Schema: `LikePage`.
#### Code samples
_Example: Example 1 · HTTP_
```
/chatter/feed-elements/005B0000000GPo4/capabilities/chatter-likes/items
```
### POST Feed Elements Capability, Chatter Likes Items
`POST /chatter/feed-elements/{feedElementId}/capabilities/chatter-likes/items`
Operation ID: `postChatterLikesCapabilityItems`. Tags: Feed Elements Resources.
Used to access a page of likes for a specific feed element, or to add a like to a specific feed element.
Like a feed element.
**Note**: POST doesn’t take request parameters or a request body.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/chatter-likes/items`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Like_ Success
Media type: `application/json`. Schema: `Like`.
### PATCH Feed Elements Capability, Chatter Likes Items
`PATCH /chatter/feed-elements/{feedElementId}/capabilities/chatter-likes/items`
Operation ID: `patchChatterLikesCapabilityItems`. Tags: Feed Elements Resources.
Used to access a page of likes for a specific feed element, or to add a like to a specific feed element.
Like or unlike a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v39.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/chatter-likes/items`
_Available in: v39.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `isLikedByCurrentUser` (query, boolean, required)
Specifies whether the context user likes ( `true` ) or unlikes ( `false` ) the feed element.
_Available in: v39.0_
#### Responses
* **200** _Like Page_ Page of Chatter likes.
Media type: `application/json`. Schema: `LikePage`.
### GET Feed Elements Capability, Close
`GET /chatter/feed-elements/{feedElementId}/capabilities/close`
Operation ID: `getCloseCapability`. Tags: Feed Elements Resources.
Used to get or set the closed state of a feed element.
Get the closed status of a feed element.
Users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. If the closed feed element is a poll, users can’t vote on it. Users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer.
Admins and moderators can edit and delete closed feed elements and comments on closed feed elements. Admins and moderators can select or remove the best answer status on comments on closed feed elements.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v43.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/close`
_Available in: v43.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Close Capability_
If a feed element has this capability, users with permission can close it.
Users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. If the closed feed element is a poll, users can’t vote on it. Users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer.
Admins and moderators can edit and delete closed feed elements and comments on closed feed elements. Admins and moderators can select or remove the best answer status on comments on closed feed elements.
Media type: `application/json`. Schema: `CloseCapability`.
### PATCH Feed Elements Capability, Close
`PATCH /chatter/feed-elements/{feedElementId}/capabilities/close`
Operation ID: `patchCloseCapability`. Tags: Feed Elements Resources.
Used to get or set the closed state of a feed element.
Set a feed element to closed.
Users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. If the closed feed element is a poll, users can’t vote on it. Users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer.
Admins and moderators can edit and delete closed feed elements and comments on closed feed elements. Admins and moderators can select or remove the best answer status on comments on closed feed elements.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v43.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/close`
_Available in: v43.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `isClosed` (query, boolean)
Specifies whether to set the feed element to closed (`true`) or not (`false`).
You must specify `isClosed` in a query parameter or a request body.
_Available in: v43.0_
#### Request body
Set a feed element to closed. Users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. If the closed feed element is a poll, users can’t vote on it. Users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer. Admins and moderators can edit and delete closed feed elements and comments on closed feed elements. Admins and moderators can select or remove the best answer status on comments on closed feed elements.
_Available in: v43.0_
Media type: `application/json`. Schema: `CloseCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"isClosed": "true"
}
```
#### Responses
* **200** _Close Capability_
If a feed element has this capability, users with permission can close it.
Users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. If the closed feed element is a poll, users can’t vote on it. Users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer.
Admins and moderators can edit and delete closed feed elements and comments on closed feed elements. Admins and moderators can select or remove the best answer status on comments on closed feed elements.
Media type: `application/json`. Schema: `CloseCapability`.
### GET Feed Elements Capability, Comments
`GET /chatter/feed-elements/{feedElementId}/capabilities/comments`
Operation ID: `getCommentsCapability`. Tags: Feed Elements Resources.
Used to access the comments capability for a specific feed element.
Access the comments capability for a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/comments`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `sort` (query, ConnectFeedCommentSortOrder)
Order of comments. Values are:
* `CreatedDateLatestAsc` — Sorts by most recently created comments in ascending order.
* `CreatedDateOldestAsc` — Sorts by oldest comments in ascending order.
* `Relevance` — Sorts by most relevant content.
The default value is `CreatedDateLatestAsc`.
Sorting in descending order isn’t supported.
_Available in: v41.0_
* `threadedCommentsCollapsed` (query, boolean)
Specifies whether to return threaded comments in a collapsed style (`true`) or not (`false`). If you don’t specify, the default is `false`.
_Available in: v44.0_
#### Responses
* **200** _Comments Capability_ If a feed element or comment has this capability, the context user can add a comment.
Media type: `application/json`. Schema: `CommentsCapability`.
### GET Feed Elements Capability, Comments Items
`GET /chatter/feed-elements/{feedElementId}/capabilities/comments/items`
Operation ID: `getCommentsCapabilityItems`. Tags: Feed Elements Resources.
Used to access pages of comments for a specific feed element, or to add a comment to a specific feed element.
Access comments for a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/comments/items`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `page` (query, string)
The page token to use to view the page. Use the value given in the `nextPageUrl` property of the Comment Page.
_Available in: v32.0_
* `pageSize` (query, integer)
The number of comments per page. The default value is 3.
_Available in: v32.0_
* `sort` (query, ConnectFeedCommentSortOrder)
Order of comments. Values are:
* `CreatedDateLatestAsc` — Sorts by most recently created comments in ascending order.
* `CreatedDateOldestAsc` — Sorts by oldest comments in ascending order.
* `Relevance` — Sorts by most relevant content.
The default value is `CreatedDateLatestAsc`.
Sorting in descending order isn’t supported.
_Available in: v44.0_
* `threadedCommentsCollapsed` (query, boolean)
Specifies whether to return threaded comments in a collapsed style (`true`) or not (`false`). If you don’t specify, the default is `false`.
_Available in: v44.0_
#### Responses
* **200** _Comment Page_ A page of comments.
Media type: `application/json`. Schema: `CommentPage`.
### POST Feed Elements Capability, Comments Items
`POST /chatter/feed-elements/{feedElementId}/capabilities/comments/items`
Operation ID: `postCommentsCapabilityItems`. Tags: Feed Elements Resources.
Used to access pages of comments for a specific feed element, or to add a comment to a specific feed element.
Add a comment to a feed element.
To upload a binary file to attach to a comment, you must send it in a multipart/form-data request. To send the text of the comment, you can choose to include a JSON or XML rich input body part in the multipart/form-data request. Alternately, you can choose to pass the information in request parameter parts. For information about how to create the multipart/form-data message, see [Inputs and Binary File Upload Examples](/docs/platform/connect-rest-api/guide/intro_input#uploading-binary-files).
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/comments/items`
_Available in: v32.0_
Returns the same response body as the [GET /chatter/comments/{commentId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/getComment) operation. See that operation for the full response schema.
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `text` (query, string)
The comment text.
You must specify `text` in a query parameter or `body` in a request body.
_Available in: v32.0_
#### Request body
_Available in: v32.0_
Media type: `multipart/form-data`. Schema: `object`.
* `feedElementFileUpload` (_string (binary)_)
* `attachment` (_string_)
Values are:
* Attachment Input: Existing Content
* Attachment Input: New File Upload
**Important**: As of version 32.0, use the `capabilities` property.
_Available in: v24.0–31.0_
* `body` (_MessageBodyInput_)
The body of the comment.
To edit this property in a comment, make a PATCH request to `/chatter/comments/{commentId}`. Editing comments is supported in version 34.0 and later.
Rich text and inline images are supported in comment bodies in version 35.0 and later. Inline images in content bodies must use content document (069) image files previously uploaded to Salesforce. Entity links are supported in version 43.0 and later.
You must specify `text` in a query parameter or `body` in a request body.
_Available in: v23.0_
* `capabilities` (_string_)
Capabilities of the comment, such as a file attachment.
You can edit a comment’s body, but you can’t update a comment’s capabilities.
_Available in: v32.0_
* `threadParentId` (_string_) _Available in: v44.0_
#### Responses
* **200** _Comment_ A comment.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/comments/{commentId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/getComment) operation. See that operation for the full response schema.
#### Code samples
_Example: Example 1 · HTTP_
```
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"New comment"
}
]
}
}
```
_Example: Example 2 · HTTP_
```
{ "body" :
{
"messageSegments" : [
{
"type": "mention",
"id" : "005D0000001GpHp"
},
{
"type": "text",
"text" : " Did you see the new plans?"
}
]
}
}
```
_Example: Example 3 · HTTP_
```
{ "body" :
{
"messageSegments" : [
{
"type": "mention",
"id":"005D0000001LL8YIAW"
},
{
"type" : "Text",
"text" : " "
},
{
"type": "mention",
"id":"005D0000001LL8sIAG"
},
{
"type": "text",
"text":" Did you see the new plans?"
}
]
}
}
```
_Example: Example 4 · HTTP_
```
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Please take a look at this file."
}
]
},
"capabilities":{
"content":{
"contentDocumentId":"069D00000001pyS"
}
}
}
```
_Example: Example 5 · HTTP_
```
{
"body":{
"messageSegments":[
{
"markupType" : "Paragraph",
"type" : "MarkupBegin"
},
{
"markupType" : "Bold",
"type" : "MarkupBegin"
},
{
"text" : "First line of text.",
"type" : "Text"
},
{
"markupType" : "Bold",
"type" : "MarkupEnd"
},
{
"markupType" : "Paragraph",
"type" : "MarkupEnd"
},
{
"markupType" : "Paragraph",
"type" : "MarkupBegin"
},
{
"text" : " ",
"type" : "Text"
},
{
"markupType" : "Paragraph",
"type" : "MarkupEnd"
},
{
"markupType" : "Paragraph",
"type" : "MarkupBegin"
},
{
"text" : "Second line of text.",
"type" : "Text"
},
{
"markupType" : "Paragraph",
"type" : "MarkupEnd"
}
]
}
}
```
_Example: Example 6 · HTTP_
```
{
"body":{
"messageSegments":[
{
"markupType" : "Code",
"type" : "MarkupBegin"
},
{
"text" : "",
"type" : "Text"
},
{
"markupType" : "Code",
"type" : "MarkupEnd"
}
]
}
}
```
_Example: Example 7 · HTTP_
```
{
"body":{
"messageSegments":[
{
"type":"Text",
"text":"Please take a look at this file."
},
{
"type":"InlineImage",
"fileId":"069xx00000000QO",
"altText":"API Spec"
},
{
"type":"Text",
"text":"And this one."
},
{
"type":"InlineImage",
"fileId":"069xx00000000QT",
"altText":"REST API Spec"
}
]
}
}
```
### GET Feed Elements Capability, Direct Message
`GET /chatter/feed-elements/{feedElementId}/capabilities/direct-message`
Operation ID: `getDirectMessageCapability`. Tags: Feed Elements Resources.
Used to access Direct Message capability for a specific feed item.
Access the direct message capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v39.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/direct-message`
_Available in: v39.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Direct Message Capability_ If a feed element has this capability, it’s a direct message.
Media type: `application/json`. Schema: `DirectMessageCapability`.
### PATCH Feed Elements Capability, Direct Message
`PATCH /chatter/feed-elements/{feedElementId}/capabilities/direct-message`
Operation ID: `patchDirectMessageCapability`. Tags: Feed Elements Resources.
Used to access Direct Message capability for a specific feed item.
Update the members of a direct message.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v39.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/direct-message`
_Available in: v39.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Request body
Create or update the members of a direct message.
Media type: `application/json`. Schema: `DirectMessageCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"membersToAdd": [
"005R0000000I2X4",
"005R0000000I23Y",
"005R0000000IUV5"
]
}
```
#### Responses
* **200** _Direct Message Capability_ If a feed element has this capability, it’s a direct message.
Media type: `application/json`. Schema: `DirectMessageCapability`.
### GET Feed Elements Capability, Direct Message Members
`GET /chatter/feed-elements/{feedElementId}/capabilities/direct-message/members`
Operation ID: `getDirectMessageMemberCollection`. Tags: Feed Elements Resources.
Returns all the Direct Message Members for given Direct Message.
Get all the members for a direct message.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v39.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/direct-message/members`
_Available in: v39.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `page` (query, string)
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned.
_Available in: v40.0_
#### Responses
* **200** _Direct Message Member Collection_ Success
Media type: `application/json`. Schema: `DirectMessageMemberCollection`.
### GET Feed Elements Capability, Direct Message Membership Activity
`GET /chatter/feed-elements/{feedElementId}/capabilities/direct-message/membership-activity`
Operation ID: `getDirectMessageMembershipActivityCollection`. Tags: Feed Elements Resources.
Returns all the Direct Message Membersip Activities for given Direct Message.
Get the membership activities for a direct message.
_Available in: v40.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/direct-message/membership-activity`
_Available in: v40.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `page` (query, string)
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned.
_Available in: v40.0_
* `pageSize` (query, integer)
Specifies the number of items per page. Valid values are from 1 through 100. If you pass in `null`, the default size is 25.
_Available in: v40.0_
#### Responses
* **200** _Direct Message Membership Activity Collection_ A collection of direct message member activities.
Media type: `application/json`. Schema: `DirectMessageMembershipActivityCollection`.
### GET Feed Elements Capability, Direct Message Original Members
`GET /chatter/feed-elements/{feedElementId}/capabilities/direct-message/original-members`
Operation ID: `getDirectMessageOriginalMemberCollection`. Tags: Feed Elements Resources.
Returns all the Direct Message Original Members for given Direct Message.
Get the original members for a direct message.
_Available in: v40.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/direct-message/original-members`
_Available in: v40.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `page` (query, string)
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned.
_Available in: v40.0_
#### Responses
* **200** _Direct Message Member Collection_ Success
Media type: `application/json`. Schema: `DirectMessageMemberCollection`.
### GET Feed Elements Capability, Editability
`GET /chatter/feed-elements/{feedElementId}/capabilities/edit/is-editable-by-me`
Operation ID: `getFeedElementEditCapabilityIsEditableByMe`. Tags: Feed Elements Resources.
Used to determine if the context user can edit the feed element.
Indicates whether the context user can edit the feed element. Feed items are the only type of feed element that can be edited.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v34.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/edit/is-editable-by-me`
_Available in: v34.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Feed Entity Is Editable_ Indicates whether the context user can edit a feed element or comment.
Media type: `application/json`. Schema: `FeedEntityIsEditable`.
### GET Feed Elements Capability, Mute
`GET /chatter/feed-elements/{feedElementId}/capabilities/mute`
Operation ID: `getMuteCapability`. Tags: Feed Elements Resources.
Used to mute a specific feed element for the context user or retrieve the mute status of a specific feed element for the context user.
Get information about whether a feed element is muted.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v35.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/mute`
_Available in: v35.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Mute Capability_ If a feed element has this capability, users can mute it. Muted feed elements are visible in the muted feed, and invisible in all other feeds that respect mute.
Media type: `application/json`. Schema: `MuteCapability`.
### PATCH Feed Elements Capability, Mute
`PATCH /chatter/feed-elements/{feedElementId}/capabilities/mute`
Operation ID: `patchMuteCapability`. Tags: Feed Elements Resources.
Used to mute a specific feed element for the context user or retrieve the mute status of a specific feed element for the context user.
Mute or unmute a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v35.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/mute`
_Available in: v35.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `isMutedByMe` (query, boolean)
Indicates whether the feed element is muted for the context user. Default value is `false`.
You must specify `isMutedByMe` in a query parameter or a request body.
_Available in: v35.0_
#### Request body
Mute or unmute a feed element.
_Available in: v35.0_
Media type: `application/json`. Schema: `MuteCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"isMutedByMe": true
}
```
#### Responses
* **200** _Mute Capability_ If a feed element has this capability, users can mute it. Muted feed elements are visible in the muted feed, and invisible in all other feeds that respect mute.
Media type: `application/json`. Schema: `MuteCapability`.
### GET Feed Elements Capability, Poll
`GET /chatter/feed-elements/{feedElementId}/capabilities/poll`
Operation ID: `getPollCapability`. Tags: ⚠️ Deprecated, Feed Elements Resources. **Deprecated**.
Used to access a poll for a specific feed element, or update a poll on a specific feed element.
Access a poll for a feed element or vote on a poll.
To create a poll, use the Feed Elements, Post and Search resource.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/poll`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `feedItemId` (path, string, required) The `{feedItemId}` must have the type `PollPost`.
#### Responses
* **200** _Poll Capability_ If a feed element has this capability, the feed element can include a poll for voting.
Media type: `application/json`. Schema: `PollCapability`.
### PATCH Feed Elements Capability, Poll
`PATCH /chatter/feed-elements/{feedElementId}/capabilities/poll`
Operation ID: `patchPollCapability`. Tags: ⚠️ Deprecated, Feed Elements Resources. **Deprecated**.
Used to access a poll for a specific feed element, or update a poll on a specific feed element.
Access a poll for a feed element or vote on a poll.
To create a poll, use the Feed Elements, Post and Search resource.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/poll`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `myChoiceId` (query, string, required)
A poll choice ID.
_Available in: v32.0_
* `feedItemId` (path, string, required) The `{feedItemId}` must have the type `PollPost`.
#### Request body (required)
Create or vote on a poll feed element. To create a poll, use the Feed Elements, Post and Search resource. To vote on a poll, use the Feed Elements Capability, Poll resource.
#### XML example for creating a poll
```
Monday
Tuesday
```
_Available in: v32.0_
Media type: `application/json`. Schema: `PollCapabilityInput`.
_Example: example\_1_ Payload 1
Creating a poll
```
{
"choices": [
"Monday",
"Tuesday"
]
}
```
_Example: example\_2_ Payload 2
Voting on a poll
```
{
"myChoiceId": "09ATC00000001lh2AA"
}
```
#### Responses
* **200** _Poll Capability_ If a feed element has this capability, the feed element can include a poll for voting.
Media type: `application/json`. Schema: `PollCapability`.
### GET Feed Elements Capability, Question and Answers
`GET /chatter/feed-elements/{feedElementId}/capabilities/question-and-answers`
Operation ID: `getQuestionAndAnswersCapability`. Tags: Feed Elements Resources.
Used to access question and answers for a specific feed element, or update question and answers on a specific feed element.
Access question and answers for a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/question-and-answers`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Question and Answers Capability_ If a feed element has this capability, it has a question and comments on the feed element are answers to the question.
Media type: `application/json`. Schema: `QuestionAndAnswersCapability`.
### PATCH Feed Elements Capability, Question and Answers
`PATCH /chatter/feed-elements/{feedElementId}/capabilities/question-and-answers`
Operation ID: `patchQuestionAndAnswersCapability`. Tags: Feed Elements Resources.
Used to access question and answers for a specific feed element, or update question and answers on a specific feed element.
Update question and answers on a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/question-and-answers`
_Available in: v32.0_
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}/capabilities/question-and-answers](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getQuestionAndAnswersCapability) operation. See that operation for the full response schema.
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `bestAnswerId` (query, string)
A comment ID to use as a best answer for a question feed element. The best answer comment must already exist on the question feed element.
You must specify `bestAnswerId` in a query parameter or a request body.
_Available in: v32.0_
#### Request body
Create or edit a question feed element or set the best answer of the existing question feed element.
_Available in: v32.0_
Media type: `application/json`. Schema: `QuestionAndAnswersCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"bestAnswerId": "0D7D00000000lMAKAY"
}
```
#### Responses
* **200** _Question and Answers Capability_ If a feed element has this capability, it has a question and comments on the feed element are answers to the question.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements/{feedElementId}/capabilities/question-and-answers](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getQuestionAndAnswersCapability) operation. See that operation for the full response schema.
#### Code samples
_Example: Example 1 · HTTP_
```
0D7D00000000lMAKAY
Content-Type: application/json
{
"bestAnswerId": "0D7D00000000lMAKAY"
}
```
### GET Feed Elements Capability, Read By
`GET /chatter/feed-elements/{feedElementId}/capabilities/read-by`
Operation ID: `getReadByCapability`. Tags: Feed Elements Resources.
Used to mark read status of a specific feed element for the context user or retrieve the read status of a specific feed element for the context user.
Access the read by capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v40.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/read-by`
_Available in: v40.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Read By Capability_ If a feed element has this capability, the context user can mark it as read.
Media type: `application/json`. Schema: `ReadByCapability`.
### PATCH Feed Elements Capability, Read By
`PATCH /chatter/feed-elements/{feedElementId}/capabilities/read-by`
Operation ID: `patchReadByCapability`. Tags: Feed Elements Resources.
Used to mark read status of a specific feed element for the context user or retrieve the read status of a specific feed element for the context user.
Mark a feed element as read for the context user.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v40.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/read-by`
_Available in: v40.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `isReadByMe` (query, boolean)
Specifies to mark the feed element as read (`true`) for the context user.
You must specify `isReadByMe` in a query parameter or a request body.
_Available in: v40.0_
#### Request body
Mark feed elements as read by the context user.
_Available in: v40.0_
Media type: `application/json`. Schema: `ReadByCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"isReadByMe": "true"
}
```
#### Responses
* **200** _Read By Capability_ If a feed element has this capability, the context user can mark it as read.
Media type: `application/json`. Schema: `ReadByCapability`.
### GET Feed Elements Capability, Read By Items
`GET /chatter/feed-elements/{feedElementId}/capabilities/read-by/items`
Operation ID: `getReadByCapabilityItems`. Tags: Feed Elements Resources.
Used to access a page of read-by for a specific feed element
Get information about who read a feed element and when.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v40.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/read-by/items`
_Available in: v40.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `page` (query, string)
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned.
_Available in: v40.0_
* `pageSize` (query, integer)
Specifies the number of items per page. Valid values are from 1 through 100. If you pass in `null`, the default size is 25.
_Available in: v40.0_
#### Responses
* **200** _Read By Collection_ A collection of information about who read the feed element and when.
Media type: `application/json`. Schema: `ReadByCollection`.
### GET Feed Elements Capability, Status
`GET /chatter/feed-elements/{feedElementId}/capabilities/status`
Operation ID: `getStatusCapability`. Tags: Feed Elements Resources.
Used to get/set status for a specific feed element
Access the status capability of a feed post.
Only users with the Can Approve Feed Post and Comment permission can set the status of a feed post or comment.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v37.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/status`
_Available in: v37.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Status Capability_ If a feed post or comment has this capability, it has a status that determines its visibility.
Media type: `application/json`. Schema: `StatusCapability`.
### PATCH Feed Elements Capability, Status
`PATCH /chatter/feed-elements/{feedElementId}/capabilities/status`
Operation ID: `patchStatusCapability`. Tags: Feed Elements Resources.
Used to get/set status for a specific feed element
Set the status of a feed post.
Only users with the Can Approve Feed Post and Comment permission can set the status of a feed post or comment.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v37.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/status`
_Available in: v37.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `feedEntityStatus` (query, ConnectFeedEntityStatusEnum)
Status of the feed post or comment. Values are:
* `Draft` — The feed post isn’t published but is visible to the author and users with Modify All Data or View All Data permission. Comments can’t be drafts.
* `Isolated` — The feed post or comment is isolated, and only admins can see it.
* `PendingReview` — The feed post or comment isn’t approved yet and therefore isn’t published or visible.
* `Published` — The feed post or comment is approved and visible.
You must specify `feedEntityStatus` in a query parameter or a request body.
_Available in: v37.0_
#### Request body
Change the status of a feed post or comment.
_Available in: v37.0_
Media type: `application/json`. Schema: `StatusCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"feedEntityStatus": "Published"
}
```
#### Responses
* **200** _Status Capability_ If a feed post or comment has this capability, it has a status that determines its visibility.
Media type: `application/json`. Schema: `StatusCapability`.
### GET Feed Elements Capability, Upvote and Downvote
`GET /chatter/feed-elements/{feedElementId}/capabilities/up-down-vote`
Operation ID: `getUpDownVoteCapability`. Tags: Feed Elements Resources.
Used to get/update up down vote for a specific feed element
Get the upvotes and downvotes for a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v41.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/up-down-vote`
_Available in: v41.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Up Down Vote Capability_ If a feed post or comment has this capability, users can upvote or downvote it.
Media type: `application/json`. Schema: `UpDownVoteCapability`.
### PATCH Feed Elements Capability, Upvote and Downvote
`PATCH /chatter/feed-elements/{feedElementId}/capabilities/up-down-vote`
Operation ID: `patchUpDownVoteCapability`. Tags: Feed Elements Resources.
Used to get/update up down vote for a specific feed element
Upvote or downvote a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v41.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/up-down-vote`
_Available in: v41.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `vote` (query, ConnectUpDownVoteValueEnum)
Type of vote for a feed element or comment.
You must specify `vote` in a query parameter or a request body.
_Available in: v41.0_
#### Request body
_Available in: v41.0_
Media type: `application/json`. Schema: `UpDownVoteCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"vote": "Up"
}
```
#### Responses
* **200** _Up Down Vote Capability_ If a feed post or comment has this capability, users can upvote or downvote it.
Media type: `application/json`. Schema: `UpDownVoteCapability`.
### GET Feed Elements Capability, Upvote and Downvote Items
`GET /chatter/feed-elements/{feedElementId}/capabilities/up-down-vote/items`
Operation ID: `getUpDownVoteCapabilityItems`. Tags: Feed Elements Resources.
Used to access a page of up or down votes for a specific feed element.
Get a list of users who upvoted or downvoted a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v42.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/up-down-vote/items`
_Available in: v42.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `page` (query, integer)
Number of the page you want returned. Starts at 0. If you don’t specify a value or if you specify 0, the first page is returned.
_Available in: v42.0_
* `pageSize` (query, integer)
Specifies the number of items per page. Valid values are from 1 through 100. If you don’t specify a value, the default size is 25.
_Available in: v42.0_
* `vote` (query, ConnectUpDownVoteValueEnum, required)
Specifies the value of the vote for the feed element.
You can’t specify `None`.
_Available in: v42.0_
#### Responses
* **200** _Vote Collection_ A collection of upvotes or downvotes for a feed element or comment.
Media type: `application/json`. Schema: `VoteCollection`.
### GET Feed Elements Capability, Approval
`GET /chatter/feed-elements/{feedElementId}/capabilities/approval`
Operation ID: `getApprovalCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's approval capability.
Access the approval capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/approval`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Approval Capability_ If a feed element has this capability, it includes information about an approval.
Media type: `application/json`. Schema: `ApprovalCapability`.
### GET Feed Elements Capability, Associated Actions
`GET /chatter/feed-elements/{feedElementId}/capabilities/associated-actions`
Operation ID: `getAssociatedActionsCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's associated actions capability.
Access the associated actions capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v33.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/associated-actions`
_Available in: v33.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Associated Actions Capability_ If a feed element has this capability, it has platform actions associated with it.
Media type: `application/json`. Schema: `AssociatedActionsCapability`.
### GET Feed Elements Capability, Banner
`GET /chatter/feed-elements/{feedElementId}/capabilities/banner`
Operation ID: `getBannerCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's banner capability.
Access the banner capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/banner`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Banner Capability_ If this feed element has this capability, it has a banner motif and style.
Media type: `application/json`. Schema: `BannerCapability`.
### GET Feed Elements Capability, Call Collaboration
`GET /chatter/feed-elements/{feedElementId}/capabilities/call-collaboration`
Operation ID: `getCallCollaborationCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's call collaboration capability.
Access the call collaboration capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v51.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/call-collaboration`
_Available in: v51.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Call Collaboration Capability_ If a feed element has this capability, it has a recording comment.
Media type: `application/json`. Schema: `CallCollaborationCapability`.
### GET Feed Elements Capability, Canvas
`GET /chatter/feed-elements/{feedElementId}/capabilities/canvas`
Operation ID: `getCanvasCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's canvas capability.
Access the canvas capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/canvas`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Canvas Capability_ If a feed element has this capability, it renders a canvas app.
Media type: `application/json`. Schema: `CanvasCapability`.
### GET Feed Elements Capability, Case Comment
`GET /chatter/feed-elements/{feedElementId}/capabilities/case-comment`
Operation ID: `getCaseCommentCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's case comment capability.
Access the case comment capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/case-comment`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Case Comment Capability_ If a feed element has this capability, it has a case comment on the case feed.
Media type: `application/json`. Schema: `CaseCommentCapability`.
### GET Feed Elements Capability, Content
`GET /chatter/feed-elements/{feedElementId}/capabilities/content`
Operation ID: `getContentCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's content capability.
Access the content capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/content`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Content Capability_
If a comment has this capability, it has a file attachment.
For files attached to a feed post (instead of a comment) in version 36.0 and later, use Files Capability.
If content is deleted from a feed element after it’s posted or if the access to the content is changed to private, the Content Capability exists, however most of its properties are null.
Media type: `application/json`. Schema: `ContentCapability`.
### GET Feed Elements Capability, Dashboard Component Snapshot
`GET /chatter/feed-elements/{feedElementId}/capabilities/dashboard-component-snapshot`
Operation ID: `getDashboardComponentSnapshotCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's dashboard component snapshot capability.
Access the dashboard component capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/dashboard-component-snapshot`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Dashboard Component Snapshot Capability_ If a feed element has this capability, it has a dashboard component snapshot. A snapshot is a static image of a dashboard component at a specific point in time.
Media type: `application/json`. Schema: `DashboardComponentSnapshotCapability`.
### GET Feed Elements Capability, Email Message
`GET /chatter/feed-elements/{feedElementId}/capabilities/email-message`
Operation ID: `getEmailMessageCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's email message capability.
Access the email message capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/email-message`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Email Message Capability_ If a feed element has this capability, it has an email message from a case.
Media type: `application/json`. Schema: `EmailMessageCapability`.
### GET Feed Elements Capability, Enhanced Link
`GET /chatter/feed-elements/{feedElementId}/capabilities/enhanced-link`
Operation ID: `getEnhancedLinkCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's enhanced link capability.
Access the enhanced link capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/enhanced-link`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Enhanced Link Capability_ If a feed element has this capability, it has a link that may contain supplemental information like an icon, a title, and a description.
Media type: `application/json`. Schema: `EnhancedLinkCapability`.
### GET Feed Elements Capability, Extensions
`GET /chatter/feed-elements/{feedElementId}/capabilities/extensions`
Operation ID: `getExtensionsCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's extensions capability.
Access the extensions capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v40.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/extensions`
_Available in: v40.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Extensions Capability_ If a feed element has this capability, it has one or more extensions associated with it.
Media type: `application/json`. Schema: `ExtensionsCapability`.
### GET Feed Elements Capability, Feed Entity Share
`GET /chatter/feed-elements/{feedElementId}/capabilities/feed-entity-share`
Operation ID: `getFeedEntityShareCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's feed entity share capability.
Access the feed entity share capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v39.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/feed-entity-share`
_Available in: v39.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Feed Entity Share Capability_ If a feed element or comment has this capability, a feed entity is shared with it.
Media type: `application/json`. Schema: `FeedEntityShareCapability`.
### GET Feed Elements Capability, Files
`GET /chatter/feed-elements/{feedElementId}/capabilities/files`
Operation ID: `getFilesCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's files capability.
Access the files capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v37.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/files`
_Available in: v37.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Files Capability_ If a feed element has this capability, it has one or more file attachments.
Media type: `application/json`. Schema: `MultipleContentCapability`.
### GET Feed Elements Capability, Interactions
`GET /chatter/feed-elements/{feedElementId}/capabilities/interactions`
Operation ID: `getInteractionsCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's interactions capability.
Access the interactions capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v37.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/interactions`
_Available in: v37.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Interactions Capability_ If a feed element has this capability, it has information about user interactions.
Media type: `application/json`. Schema: `InteractionsCapability`.
### GET Feed Elements Capability, Link
`GET /chatter/feed-elements/{feedElementId}/capabilities/link`
Operation ID: `getLinkCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's link capability.
Access the link capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/link`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Link Capability_ If a feed element has this capability, it has a link.
Media type: `application/json`. Schema: `LinkCapability`.
### GET Feed Elements Capability, Media References
`GET /chatter/feed-elements/{feedElementId}/capabilities/media-references`
Operation ID: `getMediaReferenceCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's media references capability.
Access the media references capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v41.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/media-references`
_Available in: v41.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Media Reference Capability_ If a feed element has this capability, it has one or more media references.
Media type: `application/json`. Schema: `MediaReferenceCapability`.
### GET Feed Elements Capability, Origin
`GET /chatter/feed-elements/{feedElementId}/capabilities/origin`
Operation ID: `getOriginCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's origin capability.
Access the origin capability of a feed element. If a feed element has this capability, it was created by a feed action.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v33.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/origin`
_Available in: v33.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Origin Capability_ If a feed element has this capability, it was created by a feed action.
Media type: `application/json`. Schema: `OriginCapability`.
### GET Feed Elements Capability, Recommendations
`GET /chatter/feed-elements/{feedElementId}/capabilities/recommendations`
Operation ID: `getRecommendationsCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's recommendations capability.
Access the recommendations capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/recommendations`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Recommendations Capability_ If a feed element has this capability, it has a recommendation.
Media type: `application/json`. Schema: `RecommendationsCapability`.
### GET Feed Elements Capability, Record Snapshot
`GET /chatter/feed-elements/{feedElementId}/capabilities/record-snapshot`
Operation ID: `getRecordSnapshotCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's record snapshot capability.
Access the record snapshot capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/record-snapshot`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Record Snapshot Capability_ If a feed element has this capability, it contains all the snapshotted fields of a record for a single create record event.
Media type: `application/json`. Schema: `RecordSnapshotCapability`.
### GET Feed Elements Capability, Social Post
`GET /chatter/feed-elements/{feedElementId}/capabilities/social-post`
Operation ID: `getSocialPostCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's social post capability.
Access the social post capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v37.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/social-post`
_Available in: v37.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Social Post Capability_ If a feed element has this capability, it can interact with a social post on a social network.
Media type: `application/json`. Schema: `SocialPostCapability`.
### GET Feed Elements Capability, Tracked Changes
`GET /chatter/feed-elements/{feedElementId}/capabilities/tracked-changes`
Operation ID: `getTrackedChangesCapability`. Tags: Feed Elements Resources.
Used to access a specific feed element's tracked changes capability.
Access the tracked changes capability of a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v32.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/tracked-changes`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of a feed element.
#### Responses
* **200** _Tracked Changes Capability_ If a feed element has this capability, it contains all changes to a record for a single tracked change event.
Media type: `application/json`. Schema: `TrackedChangesCapability`.
### GET Related Questions
`GET /chatter/feed-elements/{feedElementId}/related-posts`
Operation ID: `getRelatedFeedPostCollection`. Tags: Feed Elements Resources.
Get the related feed posts for a specific feed element.
Get questions related to the context question.
Each related feed post has a score indicating how closely it’s related to the context feed post. We return related feed posts sorted by score, with the highest score first.
_Available in: v37.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/related-posts`
_Available in: v37.0_
#### Parameters
* `feedElementId` (path, string (Id), required) `feedElementId` must be a question ID.
* `filter` (query, ConnectRelatedFeedPostTypeEnum)
Specifies the related question type. Values are:
* `Answered` — Related questions that have at least one answer.
* `BestAnswer` — Related questions that have a best answer.
* `Generic` — All types of related questions, including answered, with a best answer, and unanswered.
* `Unanswered` — Related questions that don’t have answers.
If not specified, `Generic` is the default value.
_Available in: v37.0_
* `maxResults` (query, integer)
The maximum number of results to return. You can return up to 25 results; 5 is the default.
If not specified, 5 is the default value.
_Available in: v37.0_
#### Responses
* **200** _Related Feed Post Collection_ A collection of related feed posts.
Media type: `application/json`. Schema: `AbstractRelatedFeedPostCollection`.
### GET Feeds
`GET /chatter/feeds`
Operation ID: `getFeedDirectory`. Tags: Feeds Resources.
A list of all of the feeds the logged in user is able to view. Each user may have a different set of feeds. Use this resource to determine what feeds are available. In addition, the different feeds may have unique labels as well as URLs. Use the given labels returned in this resource and avoid hard-coding any of these values.
A list of all of the feeds the context user is able to view.
Each user may have a different set of feeds. Use this resource to determine what feeds are available. In addition, the different feeds may have unique labels as well as URLs. Use the given labels returned in this resource and avoid hard-coding any of these values.
_Available in: v23.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds`
_Available in: v23.0_
#### Responses
* **200** _Feed Directory_ Feed directory.
Media type: `application/json`. Schema: `FeedDirectory`.
### GET List of Favorites
`GET /chatter/feeds/favorites/{userId}`
Operation ID: `getFeedFavoritesDirectory`. Tags: Favorites Feed Resources.
Returns a list of all the favorites for the logged-in user. Creates a favorite of a Chatter feed search.
Returns all the favorites for the context user.
Favorites are feed searches, list views, and topics that the context user has added as a Chatter favorite.
_Available in: v24.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/favorites/{userId}`
_Available in: v24.0_
#### Parameters
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Favorites Page_ Success
Media type: `application/json`. Schema: `FavoritesPage`.
### POST List of Favorites
`POST /chatter/feeds/favorites/{userId}`
Operation ID: `postFeedFavoritesDirectory`. Tags: Favorites Feed Resources.
Returns a list of all the favorites for the logged-in user. Creates a favorite of a Chatter feed search.
Creates a favorite of a Chatter feed search or topic.
Favorites are feed searches, list views, and topics that the context user has added as a Chatter favorite.
_Note_: The response contains feed searches that were saved using the web UI. However, you can't use Connect REST API to save a feed search.
_Available in: v24.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/favorites/{userId}`
_Available in: v24.0_
#### Parameters
* `searchText` (query, string)
Text of the feed search. Use this parameter for feed searches only.
_Available in: v24.0_
* `targetId` (query, string)
Id of the topic. Use this parameter for topics only.
_Available in: v28.0_
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Request body
_Available in: v24.0_
Media type: `application/json`. Schema: `FeedFavoriteInput`.
#### Responses
* **200** _Favorite_ Success
Media type: `application/json`. Schema: `Favorite`.
#### Code samples
_Example: Example 1 · HTTP_
```
{
"searchText" : "release",
"targetId" : "0TOD0000000099d"
}
```
### GET Favorite
`GET /chatter/feeds/favorites/{userId}/{favoriteId}`
Operation ID: `getFeedFavorite`. Tags: Favorites Feed Resources.
Returns the feed for the specified favorite. Deletes the specified favorite. Updates the last view date of the specified favorite.
Returns the feed for the specified favorite.
Favorites are feed searches, list views, and topics that the context user has added as a Chatter favorite.
_Available in: v24.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/favorites/{userId}/{favoriteId}`
_Available in: v24.0_
#### Parameters
* `favoriteId` (path, string (Id), required) ID of the favorite.
Pattern: ^(07F)\\w\*.
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Favorite_ Success
Media type: `application/json`. Schema: `Favorite`.
### DELETE Favorite
`DELETE /chatter/feeds/favorites/{userId}/{favoriteId}`
Operation ID: `deleteFeedFavorite`. Tags: Favorites Feed Resources.
Returns the feed for the specified favorite. Deletes the specified favorite. Updates the last view date of the specified favorite.
Deletes the specified favorite.
Favorites are feed searches, list views, and topics that the context user has added as a Chatter favorite.
_Available in: v24.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/favorites/{userId}/{favoriteId}`
_Available in: v24.0_
#### Parameters
* `favoriteId` (path, string (Id), required) ID of the favorite.
Pattern: ^(07F)\\w\*.
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** Success
### PATCH Favorite
`PATCH /chatter/feeds/favorites/{userId}/{favoriteId}`
Operation ID: `patchFeedFavorite`. Tags: Favorites Feed Resources.
Returns the feed for the specified favorite. Deletes the specified favorite. Updates the last view date of the specified favorite.
Updates the last view date of the specified favorite.
Favorites are feed searches, list views, and topics that the context user has added as a Chatter favorite.
_Available in: v24.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/favorites/{userId}/{favoriteId}`
_Available in: v24.0_
#### Parameters
* `favoriteId` (path, string (Id), required) ID of the favorite.
Pattern: ^(07F)\\w\*.
* `updateLastViewDate` (query, boolean) Sets the last view date of the specified feed favorite to the current system time. Default value is `false`.
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Request body
Media type: `application/json`. Schema: `FeedFavoriteInput`.
#### Responses
* **200** _Favorite_ Success
Media type: `application/json`. Schema: `Favorite`.
#### Code samples
_Example: Example 1 · HTTP_
```
{
"updateLastViewDate" : "true"
}
```
### GET Favorites Feed Elements
`GET /chatter/feeds/favorites/{userId}/{favoriteId}/feed-elements`
Operation ID: `getFeedFavoriteFeedElementCollection`. Tags: Favorites Feed Resources.
Returns a filtered feed, only showing those feed elements for the specified favorite.
Returns a filtered feed, only showing those feed elements for the specified favorite.
_Available in: v31.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/favorites/{userId}/{favoriteId}/feed-elements`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `favoriteId` (path, string (Id), required) ID of the favorite.
Pattern: ^(07F)\\w\*.
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
Bundled posts contain feed-tracked changes and are in record feeds only.
_Available in: v31.0_
* `page` (query, string)
Page token to use to view the page. Page tokens are returned as part of the response class, for example, `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in `null`, the default size is 25.
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to return with each feed element. The default value is 3.
_Available in: v31.0_
* `sort` (query, ConnectFeedSortOrder)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` — Sorts by most recent creation date.
* `LastModifiedDateDesc` — Sorts by most recent activity.
* `MostViewed` — Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` — Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
If you pass in `null`, the default value `CreatedDateDesc` is used.
_Available in: v31.0_
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed Element Page_ Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
### GET List of Filter Feed URLs
`GET /chatter/feeds/filter/{userId}`
Operation ID: `getFilterFeedDirectory`. Tags: Filter Feed Resources.
Use this resource to return a list of the possible key prefix filters that the user can apply to their news feed. You should get this list, then construct additional resource URLs using the key prefixes that are returned. If this list is empty, it means the user isn’t following anything.
Use this resource to return a list of the possible key prefix filter feeds that the context user can apply to their news feed. See [Filter Feed Elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Filter-Feed-Resources/operation/getFilterFeedElementCollection).
_Available in: v23.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/filter/{userId}`
_Available in: v23.0_
#### Parameters
* `userId` (path, string, required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed Directory_ If the response body is empty, the user isn’t following any records.
Media type: `application/json`. Schema: `FeedDirectory`.
### GET Specific Filter Feed URL
`GET /chatter/feeds/filter/{userId}/{keyPrefix}`
Operation ID: `getFilterFeed`. Tags: Filter Feed Resources.
Use this resource to return the URL for the specified key prefix news feed. The key prefix is the three-character prefix code in the object ID. Object IDs are prefixed with three-character codes that specify the type of the object. For example, User objects have a prefix of 005 and Group objects have a prefix of 0F9. You don’t need to generate the key prefixes yourself. Use the List of Filters to see the available key prefixes.
A feed object that contains information about a specific filter feed available to the context user.
_Available in: v23.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/filter/{userId}/{keyPrefix}`
_Available in: v23.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `keyPrefix` (path, string (IdPrefix), required) The first three characters of the object ID that indicates the object type.
* `sort` (query, ConnectFeedSortOrder)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` — Sorts by most recent creation date.
* `LastModifiedDateDesc` — Sorts by most recent activity.
* `MostViewed` — Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` — Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc`.
* `userId` (path, string, required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed_ Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Code samples
_Example: Example 1 · HTTP_
```
# This request returns the URL for a filter feed items resource that’s filtered
# by the User object (key prefix `005` ).
GET /chatter/feeds/filter/me/005
```
### GET Filter Feed Elements
`GET /chatter/feeds/filter/{userId}/{keyPrefix}/feed-elements`
Operation ID: `getFilterFeedElementCollection`. Tags: Filter Feed Resources.
Use this resource to return the feed elements from the news feed that are found on parents with the specified key prefix. For example, the feed elements from all the groups the logged-in user is a member of.
Feed elements from the context user’s news feed whose parent has the specified key prefix, such as the feed elements from all the groups the context user is a member of.
The key prefix specifies the object type and is the first three characters of an object ID.
To filter by feed elements with a User parent object, use the key prefix `005`.
To filter by feed elements with a Group parent object, use the key prefix `0F9`.
To filter by feed elements with a parent object that the context user is following (for example, Account), use the [List of Filter Feed URLs](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Filter-Feed-Resources/operation/getFilterFeedDirectory) to return the parent objects.
Suppose the context user is a member of five groups. The following resource returns all of the feed elements for all five of those groups:
```
/chatter/feeds/filter/me/0F9/feed-elements
```
The filter feed returns only the feed elements that are visible to the context user. In this example, the resource doesn’t return the feed elements for groups the context user is not a member of.
_Available in: v31.0_
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/filter/{userId}/{keyPrefix}/feed-elements`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `keyPrefix` (path, string (IdPrefix), required) The first three characters of the object ID that indicates the object type.
* `density` (query, ConnectFeedDensityEnum)
* `AllUpdates` — Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` — Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
Bundled posts contain feed-tracked changes and are in record feeds only.
_Available in: v31.0_
* `page` (query, string)
Page token to use to view the page. Page tokens are returned as part of the response class, for example, `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in `null`, the default size is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the feed elements visible to the context user. The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to return with each feed element. The default value is 3.
_Available in: v31.0_
* `sort` (query, ConnectFeedSortOrder)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` — Sorts by most recent creation date.
* `LastModifiedDateDesc` — Sorts by most recent activity.
* `MostViewed` — Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` — Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
If you pass in `null`, the default value `CreatedDateDesc` is used.
_Available in: v31.0_
* `updatedSince` (query, string)
Opaque token defining the modification timestamp of the feed and the sort order.
The `updatedSince` parameter doesn’t return feed elements that are created in the same second as the request.
_Available in: v31.0_
* `userId` (path, string, required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
### GET Experience Cloud Sites Comment Moderation
`GET /connect/communities/{communityId}/chatter/comments/{commentId}/moderation-flags`
Operation ID: `getFlagsOnComment`. Tags: Experience Cloud Site Comments Moderation Resources.
Used to flag or remove one or more flags from a specific comment. This resource is only available in communities.
If the context user is a moderator, get the number of times members flagged a comment. If the context user isn’t a moderator, returns whether the user flagged a comment.
_Available in: v29.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site.
* `page` (query, string)
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned.
_Available in: v40.0_
* `pageSize` (query, integer)
Specifies the number of items per page. Valid values are from 1 through 100. The default size is 0.
_Available in: v40.0_
* `visibility` (query, ConnectNetworkModerationVisibilityEnum)
Visibility behavior of a flag for various user types.
* `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item.
* `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
_Available in: v30.0_
#### Responses
* **200** _Moderation Flags_ Success
Media type: `application/json`. Schema: `ModerationFlags`.
### POST Experience Cloud Sites Comment Moderation
`POST /connect/communities/{communityId}/chatter/comments/{commentId}/moderation-flags`
Operation ID: `addFlagToComment`. Tags: Experience Cloud Site Comments Moderation Resources.
Used to flag or remove one or more flags from a specific comment. This resource is only available in communities.
If the context user is or isn’t a moderator, flag a comment for moderation.
_Available in: v29.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site.
* `note` (query, string)
A note of up to 4,000 characters about the flag.
_Available in: v38.0_
* `type` (query, ConnectNetworkModerationTypeEnum)
Type of moderation flag.
* `FlagAsInappropriate` — Flag for inappropriate content.
* `FlagAsSpam` — Flag for spam.
If a type isn’t specified, it defaults to `FlagAsInappropriate`.
_Available in: v38.0_
* `visibility` (query, ConnectNetworkModerationVisibilityEnum)
Visibility behavior of a flag for various user types.
* `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item.
* `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
_Available in: v30.0_
#### Request body
_Available in: v38.0_
Media type: `application/json`. Schema: `ModerationFlagInput`.
#### Responses
* **200** _Moderation Flags_ Success
Media type: `application/json`. Schema: `ModerationFlags`.
#### Code samples
_Example: Example 1 · HTTP_
```
{
"note" : "Flagged by moderator as spam on 6.6.16.",
"type" : "FlagAsSpam",
"visibility" : "ModeratorsOnly"
}
```
### DELETE Experience Cloud Sites Comment Moderation
`DELETE /connect/communities/{communityId}/chatter/comments/{commentId}/moderation-flags`
Operation ID: `removeFlagFromComment`. Tags: Experience Cloud Site Comments Moderation Resources.
Used to flag or remove one or more flags from a specific comment. This resource is only available in communities.
If the context user is a moderator, delete all flags on a comment. If the context user isn’t a moderator, remove a flag the user previously added.
_Available in: v29.0_
#### Parameters
* `commentId` (path, string (Id), required) ID of a comment.
Pattern: ^(0D7)\\w\*.
* `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site.
* `userId` (query, string)
The ID of the context user. If specified, removes the flag the user previously added to the comment. If not specified and the context user is a moderator, removes all flags on the comment.
_Available in: v29.0_
#### Responses
* **200** Success
### GET Feed Elements Capability, Moderation
`GET /connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/moderation`
Operation ID: `getFlagsOnFeedElement`. Tags: Feed Elements Resources.
Used to flag or remove one or more flags from a specific feed element.
Get information about a feed element's moderation capability.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v31.0_
#### Parameters
* `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site.
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `page` (query, string)
Specifies the page token to use to view a page of information. Page tokens are returned as part of the response class, such as `currentPageToken` or `nextPageToken`. If you pass in `null`, the first page is returned.
_Available in: v40.0_
* `pageSize` (query, integer)
Specifies the number of items per page. Valid values are from 1 through 100. The default size is 0.
_Available in: v40.0_
* `visibility` (query, ConnectNetworkModerationVisibilityEnum)
Visibility behavior of a flag for various user types. One of these values:
* `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item.
* `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
_Available in: v31.0_
#### Responses
* **200** _Moderation Capability_ If a feed element has this capability, users in the Experience Cloud site can flag the feed element for moderation. This response body also includes information about the flagged content.
Media type: `application/json`. Schema: `ModerationCapability`.
### POST Feed Elements Capability, Moderation
`POST /connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/moderation`
Operation ID: `addFlagToFeedElement`. Tags: Feed Elements Resources.
Used to flag or remove one or more flags from a specific feed element.
Add a moderation flag to a feed element.
If the feed element doesn’t support this capability, the response is 404: Not Found.
_Available in: v31.0_
#### Parameters
* `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site.
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `note` (query, string)
A note of up to 4,000 characters about the flag.
_Available in: v38.0_
* `type` (query, ConnectNetworkModerationTypeEnum)
Type of moderation flag.
* `FlagAsInappropriate` — Flag for inappropriate content.
* `FlagAsSpam` — Flag for spam.
If a type isn’t specified, it defaults to `FlagAsInappropriate`.
_Available in: v38.0_
* `visibility` (query, ConnectNetworkModerationVisibilityEnum)
Visibility behavior of a flag for various user types. One of these values:
* `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item.
* `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
_Available in: v31.0_
#### Request body
Moderation flag input.
_Available in: v38.0_
Media type: `application/json`. Schema: `ModerationFlagInput`.
_Example: example\_1_ Payload 1
```
{
"note": "Flagged by moderator as spam on 6.6.16.",
"type": "FlagAsSpam",
"visibility": "ModeratorsOnly"
}
```
#### Responses
* **200** _Moderation Capability_ If a feed element has this capability, users in the Experience Cloud site can flag the feed element for moderation. This response body also includes information about the flagged content.
Media type: `application/json`. Schema: `ModerationCapability`.
### DELETE Feed Elements Capability, Moderation
`DELETE /connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/moderation`
Operation ID: `removeFlagFromFeedElement`. Tags: Feed Elements Resources.
Used to flag or remove one or more flags from a specific feed element.
Delete all moderation flags from a feed element.
_Available in: v31.0_
#### Parameters
* `communityId` (path, string (CommunityId), required) ID of an Experience Cloud site.
* `feedElementId` (path, string (Id), required) ID of a feed element.
* `userId` (query, string)
The ID of the context user. If specified, removes the flag the user previously added to the post. If not specified and the context user is a moderator, removes all flags on the post.
_Available in: v29.0_
#### Responses
* **200** _Status Codes and Error Responses_ The response header contains an HTTP status code. If the response isn’t successful, the response body contains an error message, and if appropriate, information about the field or object where the error occurred.
### GET Bookmarks Feed URL
`GET /chatter/feeds/bookmarks/{userId}`
Operation ID: `get_connect_resource_feeds_bookmarks__cc_all_bookmarks`. Tags: Bookmarks Feed Resources.
Returns the URL for the bookmarks feed for the context user.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/bookmarks/{userId}`
_Available in: v24.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Bookmarks Feed Elements
`GET /chatter/feeds/bookmarks/{userId}/feed-elements`
Operation ID: `get_connect_resource_feeds_bookmarks__cc_bookmarks_feed_elements`. Tags: Bookmarks Feed Resources.
Returns all feed elements bookmarked by the context user.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/bookmarks/{userId}/feed-elements`
_Available in: v24.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
Bundled posts contain feed-tracked changes and are in record feeds only.
_Available in: v31.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are between 1 and 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body, in one of the URL
# parameters, such as nextPageURL, for example:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Company Feed URL
`GET /chatter/feeds/company`
Operation ID: `get_connect_resource_feeds_company__cc_company_feed_url`. Tags: Company Feed Resources.
Returns a URL to the company feed and a page of feed elements.
_Available in: v23.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `pageSize` (query, integer) Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in 0, feed elements aren’t returned with the feed.
* `recentCommentCount` (query, integer) Maximum number of comments to return with each feed element. The default value is 3.
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Company Feed Elements
`GET /chatter/feeds/company/feed-elements`
Operation ID: `get_connect_resource_feeds_company__cc_company_feed_elements`. Tags: Company Feed Resources.
Returns the feed elements of a company feed.
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
_Available in: v31.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `updatedSince` (query, string)
An opaque token defining the modification time stamp of the feed and the sort order.
Do not construct this token. Retrieve this token from the `updatesToken` property of the Feed Element Page response body.
The `updatedSince` parameter doesn’t return feed elements that are created in the same second as the request.
_Available in: v31.0_
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body in one of the URL
# parameters, such as nextPageURL:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Direct Messages Feed URL
`GET /chatter/feeds/direct-messages`
Operation ID: `get_connect_resource_feeds_direct_messages__direct_messages_feed_url`. Tags: Direct Messages Feed Resources.
Get the URL to the context user’s direct messages feed and a page of feed elements.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/direct-messages`
_Available in: v39.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `pageSize` (query, integer) Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in 0, feed elements aren’t returned with the feed.
* `recentCommentCount` (query, integer) Maximum number of comments to return with each feed element. The default value is 3.
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Direct Messages Feed Elements
`GET /chatter/feeds/direct-messages/feed-elements`
Operation ID: `get_connect_resource_feeds_direct_messages__direct_messages_feed_elements`. Tags: Direct Messages Feed Resources.
Get all the feed elements for the context user’s direct messages.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/direct-messages/feed-elements`
_Available in: v39.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed. The only valid value is `LastModifiedDateDesc` , which sorts the feed by the most recent activity.
_Available in: v31.0_
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body in one of the URL
# parameters, such as nextPageURL:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Draft Feed URL
`GET /chatter/feeds/draft/{userId}`
Operation ID: `get_connect_resource_feeds_draft__draft_feed_url`. Tags: Draft Feed Resources.
Get the URL to the draft feed.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/draft/{userId}`
_Available in: v44.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Draft Feed Elements
`GET /chatter/feeds/draft/{userId}/feed-elements`
Operation ID: `get_connect_resource_feeds_draft__draft_feed_elements`. Tags: Draft Feed Resources.
Get all the posts that the context user drafted.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/draft/{userId}/feed-elements`
_Available in: v44.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
_Available in: v31.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body in one of the URL
# parameters, such as nextPageURL:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Files Feed URL
`GET /chatter/feeds/files/{userId}`
Operation ID: `get_connect_resource_feeds_files__cc_files_feed_url`. Tags: Files Feed Resources.
Returns the URL to the feed elements that contain files that are posted by users or groups the context user is following.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/files/{userId}`
_Available in: v23.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Files Feed Elements
`GET /chatter/feeds/files/{userId}/feed-elements`
Operation ID: `get_connect_resource_feeds_files__cc_files_feed_elements`. Tags: Files Feed Resources.
Returns all feed elements posted with files by people or groups that the context user follows.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/files/{userId}/feed-elements`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
_Available in: v31.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `updatedSince` (query, string)
An opaque token defining the modification time stamp of the feed and the sort order.
Do not construct this token. Retrieve this token from the `updatesToken` property of the Feed Element Page response body.
The `updatedSince` parameter doesn’t return feed elements that are created in the same second as the request.
_Available in: v31.0_
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body in one of the URL
# parameters, such as nextPageURL:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Groups Feed URL
`GET /chatter/feeds/groups/{userId}`
Operation ID: `get_connect_resource_feeds_groups__cc_groups_feed_url`. Tags: Groups Feed Resources.
Returns a URL to the feed elements for all the groups the context user is a member of.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/groups/{userId}`
_Available in: v23.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Groups Feed Elements
`GET /chatter/feeds/groups/{userId}/feed-elements`
Operation ID: `get_connect_resource_feeds_groups__cc_groups_feed_elements`. Tags: Groups Feed Resources.
Returns all feed elements for all groups the context user either owns or is a member of.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/groups/{userId}/feed-elements`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
_Available in: v31.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `updatedSince` (query, string)
An opaque token defining the modification time stamp of the feed and the sort order.
Do not construct this token. Retrieve this token from the `updatesToken` property of the Feed Element Page response body.
The `updatedSince` parameter doesn’t return feed elements that are created in the same second as the request.
_Available in: v31.0_
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body in one of the URL
# parameters, such as nextPageURL:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Isolated Feed URL
`GET /chatter/feeds/isolated`
Operation ID: `get_connect_resource_feeds_isolated__isolated_feed_url`. Tags: Isolated Feed Resources.
Get the URL to the isolated feed and a page of feed elements.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/isolated`
_Available in: v60.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `pageSize` (query, integer) Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in 0, feed elements aren’t returned with the feed.
* `recentCommentCount` (query, integer) Maximum number of comments to return with each feed element. The default value is 3.
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Isolated Feed Elements
`GET /chatter/feeds/isolated/feed-elements`
Operation ID: `get_connect_resource_feeds_isolated__isolated_feed_elements`. Tags: Isolated Feed Resources.
Get all the feed elements and comments that are isolated.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/isolated/feed-elements`
_Available in: v60.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`.
_Available in: v39.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 to 100. If you don't specify a size, the default is 25.
_Available in: v39.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v39.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v39.0_
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# A generated token that indicates the view of feed elements in the feed. Page
# tokens are returned as part of the response body, in one of the URL
# parameters, such as nextPageURL. For example:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Landing Feed
`GET /chatter/feeds/landing`
Operation ID: `get_connect_resource_feeds_landing`. Tags: Landing Feed Resources.
Get information about the landing feed and a page of feed elements.
_Available in: v40.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `pageSize` (query, integer) Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in 0, feed elements aren’t returned with the feed.
* `recentCommentCount` (query, integer) Maximum number of comments to return with each feed element. The default value is 3.
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
For the landing feed, the service determines the sort order and any `sort` value you specify is ignored.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Mute Feed URL
`GET /chatter/feeds/mute/{userId}`
Operation ID: `get_connect_resource_feeds_mute__cc_all_mute`. Tags: Mute Feed Resources.
Returns the URL for the mute feed for the context user.
To mute an item, use PATCH with the [Feed Elements Capability, Mute](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getMuteCapability) resource and the `isMutedByMe` parameter. For example:
```
/chatter/feed-elements/0D5D0000000Ir6zKAC/capabilities/mute?isMutedByMe=true
```
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/mute/{userId}`
_Available in: v35.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Mute Feed Elements
`GET /chatter/feeds/mute/{userId}/feed-elements`
Operation ID: `get_connect_resource_feeds_mute__cc_mute_feed_elements`. Tags: Mute Feed Resources.
Returns all feed elements that the context user muted.
To mute an item, use PATCH with the [Feed Elements Capability, Mute](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getMuteCapability) resource and the `isMutedByMe` parameter. For example:
```
/chatter/feed-elements/0D5D0000000Ir6zKAC/capabilities/mute?isMutedByMe=true
```
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/mute/{userId}/feed-elements`
_Available in: v35.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
Bundled posts contain feed-tracked changes and are in record feeds only.
_Available in: v31.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are between 1 and 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body, in one of the URL
# parameters, such as nextPageURL, for example:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET News Feed URL
`GET /chatter/feeds/news/{userId}`
Operation ID: `get_connect_resource_feeds_news__cc_news_feed_url`. Tags: News Feed Resources.
Returns a URL to the feed elements for all feeds for the context user.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/news/{userId}`
_Available in: v23.0_
#### Parameters
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `Feed`.
#### Code samples
_Example: Example response body · HTTP_
```
{
"feedElementPostUrl": "/services/data/v/chatter/feed-elements",
"feedElementsUrl": "/services/data/v/chatter/feeds/news/005xx000001Sv1mAAB/feed-elements"
}
```
### GET News Feed Elements
`GET /chatter/feeds/news/{userId}/feed-elements`
Operation ID: `get_connect_resource_feeds_news__cc_news_feed_elements`. Tags: News Feed Resources.
All feed elements from all groups the context user either owns or is a member of, as well as all files, records, and users the context user follows. Use this resource to get information about feed elements and to post feed elements.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/news/{userId}/feed-elements`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
Bundled posts contain feed-tracked changes and are in record feeds only.
_Available in: v31.0_
* `filter` (query, string)
Filter value for a feed.
* `AllQuestions` —Feed elements that are questions.
* `AuthoredBy` —Feed elements authored by the user profile owner. This value is valid only for the `UserProfile` feed.
* `CommunityScoped` —Feed elements that are scoped to Experience Cloud sites. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to sites in the future. Feed elements that are always visible in all sites are filtered out. This value is valid only for the `UserProfile` feed.
* `QuestionsWithCandidateAnswers` — Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `QuestionsWithCandidateAnswersReviewedPublished` — Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `Read` —Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the `Record` feed of a group.
* `SolvedQuestions` —Feed elements that are questions and that have a best answer.
* `UnansweredQuestions` —Feed elements that are questions and that don’t have any answers.
* `UnansweredQuestionsWithCandidateAnswers` — Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `Unread` —Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the `Record` feed of a group.
* `UnsolvedQuestions` —Feed elements that are questions and that don’t have a best answer.
_Available in: v32.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `updatedSince` (query, string)
An opaque token defining the modification time stamp of the feed and the sort order.
Do not construct this token. Retrieve this token from the `updatesToken` property of the Feed Element Page response body.
The `updatedSince` parameter doesn’t return feed elements that are created in the same second as the request.
_Available in: v31.0_
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body, in one of the URL
# parameters, such as nextPageURL:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET News Feed Is-Modified
`GET /chatter/feeds/news/{userId}/is-modified`
Operation ID: `get_connect_resource_feeds_news__cc_news_feed_is_modified`. Tags: News Feed Resources.
Returns information about whether the news feed has been updated or changed since the specified time and date.
If you are working with remote organizations such as an ISV, use the `/connect/organization` resource and the `feedPolling` property of the Feature response body to shape your polling strategy. If `feedPolling` isn't enabled, be conservative in how often you poll for new content.
_Available in: v26.0_
#### Use the Is-Modified resource to poll the news feed
1. Use either of the following resources to get the latest elements from a news feed or to get information about the feed: [`/chatter/feeds/news/me/feed-elements`](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_elements), [`/chatter/feeds/news/me`](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url). The response bodies for both resources contain the `isModifiedUrl` property. This property contains the URL to the Is-Modified resource, which includes a `{since}` request parameter that defines the last modified date of the feed. If the sort order of the request to the news feed changes, the news feed is modified.
2. Issue a GET request to the URL in the `isModifiedUrl` property. The Feed Modified Info response contains the following properties.
* `isModified` —a boolean indicating whether the feed has been updated since the last time you checked. Conditions under which this property is `true` depend on the sort order of the original request to the news feed. For example, if the feed is sorted by posts (`CreatedDateDesc`) and a comment was added, `isModified` is `false`.
* `nextPollUrl` —a string containing the URL of the Is-Modified resource. This property contains a URL only if `isModified` is `false`. If `isModified` is `true`, `nextPollUrl` is `null`.
3. If the `isModified` property is `true`, issue a GET request to the News Feed Elements resource to refresh the news feed.
4. If the `isModified` property is `false`, issue a GET request to the URL in the `nextPollUrl` property. This request also returns a Feed Modified Info response body that contains the `isModified` and `nextPollUrl` properties.
We don’t recommend exceeding one poll per minute.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/news/{userId}/is-modified`
#### Parameters
* `since` (query, string, required)
An opaque token containing information about the modification time stamp of the feed and the sort order.
Do not construct this token. Retrieve this token from the `isModifiedToken` property of the Feed Item Page or Feed Modified Info response body.
_Available in: v23.0_
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `FeedModifiedInfo`.
### GET Pending Review Feed URL
`GET /chatter/feeds/pending-review`
Operation ID: `get_connect_resource_feeds_pending_review__pending_review_feed_url`. Tags: Pending Review Feed Resources.
Get the URL to the pending review feed and a page of feed elements.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/pending-review`
_Available in: v39.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `pageSize` (query, integer) Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in 0, feed elements aren’t returned with the feed.
* `recentCommentCount` (query, integer) Maximum number of comments to return with each feed element. The default value is 3.
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Pending Review Feed Elements
`GET /chatter/feeds/pending-review/feed-elements`
Operation ID: `get_connect_resource_feeds_pending_review__pending_review_feed_elements`. Tags: Pending Review Feed Resources.
Get all the feed elements and comments that are pending review.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/pending-review/feed-elements`
_Available in: v39.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`.
_Available in: v39.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 to 100. If you don't specify a size, the default is 25.
_Available in: v39.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v39.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v39.0_
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# A generated token that indicates the view of feed elements in the feed. Page
# tokens are returned as part of the response body, in one of the URL
# parameters, such as nextPageURL. For example:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET People Feed URL
`GET /chatter/feeds/people/{userId}`
Operation ID: `get_connect_resource_feeds_people__cc_people_feed_url`. Tags: People Feed Resources.
Returns a URL to the feed elements for all the people the context user is following.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/people/{userId}`
_Available in: v23.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET People Feed Elements
`GET /chatter/feeds/people/{userId}/feed-elements`
Operation ID: `get_connect_resource_feeds_people__cc_people_feed_elements`. Tags: People Feed Resources.
Returns all the feed elements from all the people the context user follows.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/people/{userId}/feed-elements`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
_Available in: v31.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `updatedSince` (query, string)
An opaque token defining the modification time stamp of the feed and the sort order.
Do not construct this token. Retrieve this token from the `updatesToken` property of the Feed Element Page response body.
The `updatedSince` parameter doesn’t return feed elements that are created in the same second as the request.
_Available in: v31.0_
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body in one of the URL
# parameters, such as nextPageURL:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Record Feed URL
`GET /chatter/feeds/record/{recordId}`
Operation ID: `get_connect_resource_feeds_record__cc_record_feed_url`. Tags: Record Feed Resources.
Returns a URL to the feed elements for all the records the context user is following, or a URL to all the feed elements of the specified `{recordId}`. Use this resource to get a group feed.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/record/{recordId}`
_Available in: v23.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
* `recordId` (path, string (Id), required) ID of a record. If `{recordId}` is a user ID, it must be the same as the context user or the alias `me`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Record Feed Elements
`GET /chatter/feeds/record/{recordId}/feed-elements`
Operation ID: `get_connect_resource_feeds_record__cc_record_feed_elements`. Tags: Record Feed Resources.
Returns the feed elements for all the records the context user is following, or all the feed elements of the specified `{recordId}`. Use this resource to search a feed or to get the feed elements for a specific feed, including another user’s feed or a group feed.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/record/{recordId}/feed-elements`
_Available in: v23.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `customFilter` (query, string)
Custom filter that applies only to the case feed. See [customFeedFilter](https://developer.salesforce.com/docs/atlas.en-us.api_meta.meta/api_meta/meta_customfeedfilter.htm) in the Metadata API Developer Guide for supported values.
You can specify `customFilter` or `filter`. You can’t specify both.
_Available in: v40.0_
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
Bundled posts contain feed-tracked changes and are in record feeds only.
_Available in: v31.0_
* `filter` (query, string)
Specifies a filter value for a feed.
* `AllQuestions` —Feed elements that are questions.
* `AuthoredBy` —Feed elements authored by the user profile owner. This value is valid only for the `UserProfile` feed.
* `CommunityScoped` —Feed elements that are scoped to Experience Cloud sites. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to sites in the future. Feed elements that are always visible in all sites are filtered out. This value is valid only for the `UserProfile` feed.
* `QuestionsWithCandidateAnswers` — Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `QuestionsWithCandidateAnswersReviewedPublished` — Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `Read` —Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the `Record` feed of a group.
* `SolvedQuestions` —Feed elements that are questions and that have a best answer.
* `UnansweredQuestions` —Feed elements that are questions and that don’t have any answers.
* `UnansweredQuestionsWithCandidateAnswers` — Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `Unread` —Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the `Record` feed of a group.
* `UnsolvedQuestions` —Feed elements that are questions and that don’t have a best answer.
The `filter` parameter doesn’t work for group feeds.
You can specify `customFilter` or `filter`. You can’t specify both.
_Available in: v32.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are between 1 and 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `showInternalOnly` (query, boolean)
Specifies whether to show only feed elements from internal (non-site) users ( `true` ), or not ( `false` ). The default value is `false` .
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `threadedCommentsCollapsed` (query, boolean)
Specifies whether to return threaded comments in a collapsed style (`true`) or not (`false`). If you don’t specify a value, the default is `false`.
_Available in: v44.0_
* `updatedSince` (query, string)
An opaque token defining the modification time stamp of the feed and the sort order.
Do not construct this token. Retrieve this token from the `updatesToken` property of the Feed Element Page response body.
The `updatedSince` parameter doesn’t return feed elements that are created in the same second as the request.
_Available in: v31.0_
* `recordId` (path, string (Id), required) ID of a record. If `{recordId}` is a user ID, it must be the same as the context user or the alias `me`. To get the feed elements for a group, specify the group ID as the `{recordId}`.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body, in one of the URL
# parameters, such as nextPageURL, for example:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Record Pinned Feed Elements
`GET /chatter/feeds/record/{recordId}/pinned-feed-elements`
Operation ID: `get_connect_resource_feeds_record_pin`. Tags: Record Feed Resources.
Get pinned feed elements from a group feed.
In the UI, pinned feed elements don’t show all auxiliary information, such as comments, likes, interaction counts, or read by information. As a result, the Pinned Feed Element Collection doesn’t include all the information for these capabilities.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/record/{recordId}/pinned-feed-elements`
_Available in: v41.0_
#### Parameters
* `recordId` (path, string (Id), required) The `{recordId}` must be a group ID.
#### Responses
* **200** _Pinned Feed Element Collection_ Collection of pinned feed elements.
Media type: `application/json`. Schema: `PinnedFeedElementCollection`.
### PATCH Record Pinned Feed Elements
`PATCH /chatter/feeds/record/{recordId}/pinned-feed-elements`
Operation ID: `patch_connect_resource_feeds_record_pin`. Tags: Record Feed Resources.
Pin or unpin a feed element to a group feed.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/record/{recordId}/pinned-feed-elements`
_Available in: v41.0_
#### Parameters
* `recordId` (path, string (Id), required) The `{recordId}` must be a group ID.
#### Request body
Media type: `application/json`. Schema: `PinCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"entityId": "0D5B000000TW7uh",
"isPinned": "true"
}
```
#### Responses
* **200** _Pin Capability_ Success
Media type: `application/json`. Schema: `PinCapability`.
### GET Streams Feed URL
`GET /chatter/feeds/streams/{streamId}`
Operation ID: `get_connect_resource_feeds_streams__streams_feed_url`. Tags: Streams Feed Resources.
Get the URL to the streams feed.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/streams/{streamId}`
_Available in: v39.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
* `streamId` (path, string (Id), required) ID of the stream.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Streams Feed Elements
`GET /chatter/feeds/streams/{streamId}/feed-elements`
Operation ID: `get_connect_resource_feeds_streams__streams_feed_elements`. Tags: Streams Feed Resources.
Get all feed elements from any combination of up to 25 people, groups, records, and topics that the context user subscribes to in the stream.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/streams/{streamId}/feed-elements`
_Available in: v39.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
_Available in: v31.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `updatedSince` (query, string)
An opaque token defining the modification time stamp of the feed and the sort order.
Do not construct this token. Retrieve this token from the `updatesToken` property of the Feed Element Page response body.
The `updatedSince` parameter doesn’t return feed elements that are created in the same second as the request.
_Available in: v31.0_
* `streamId` (path, string (Id), required) ID of the stream.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body in one of the URL
# parameters, such as nextPageURL:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET To Feed URL
`GET /chatter/feeds/to/{userId}`
Operation ID: `get_connect_resource_feeds_to__cc_to_feed_url`. Tags: To Feed Resources.
Returns a URL to the feed elements for the feed of the context user.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/to/{userId}`
_Available in: v23.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET To Feed Elements
`GET /chatter/feeds/to/{userId}/feed-elements`
Operation ID: `get_connect_resource_feeds_to__cc_to_feed_elements`. Tags: To Feed Resources.
Returns the feed elements for all @mentions of the context user, and all posts made to the user's feed.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/to/{userId}/feed-elements`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
Bundled posts contain feed-tracked changes and are in record feeds only.
_Available in: v31.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
The number of feed elements per page. Valid values are between 1 and 100. The default size is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `userId` (path, string (Id), required) `{userId}` must be the ID of the context user or the alias `me`.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# A generated token that indicates the view of feed elements in the feed. Page
# tokens are returned as part of the response body, in one of the URL
# parameters, such as nextPageURL, for example:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Topics Feed URL
`GET /chatter/feeds/topics/{topicId}`
Operation ID: `get_connect_resource_feeds_topics__cc_topics_feed_url`. Tags: Topics Feed Resources.
Returns a URL to the feed items for the specified topic.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/topics/{topicId}`
_Available in: v28.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
* `topicId` (path, string (Id), required) ID of the topic.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Topics Feed Elements
`GET /chatter/feeds/topics/{topicId}/feed-elements`
Operation ID: `get_connect_resource_feeds_topics__cc_topics_feed_elements`. Tags: Topics Feed Resources.
Returns all feed elements for the specified topic.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/topics/{topicId}/feed-elements`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `filter` (query, string)
Filter value for a feed.
* `AllQuestions` —Feed elements that are questions.
* `AuthoredBy` —Feed elements authored by the user profile owner. This value is valid only for the `UserProfile` feed.
* `CommunityScoped` —Feed elements that are scoped to Experience Cloud sites. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to sites in the future. Feed elements that are always visible in all sites are filtered out. This value is valid only for the `UserProfile` feed.
* `QuestionsWithCandidateAnswers` — Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `QuestionsWithCandidateAnswersReviewedPublished` — Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `Read` —Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the `Record` feed of a group.
* `SolvedQuestions` —Feed elements that are questions and that have a best answer.
* `UnansweredQuestions` —Feed elements that are questions and that don’t have any answers.
* `UnansweredQuestionsWithCandidateAnswers` — Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `Unread` —Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the `Record` feed of a group.
* `UnsolvedQuestions` —Feed elements that are questions and that don’t have a best answer.
_Available in: v32.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL` .
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of feed elements per page. Valid values are between 1 and 100. The default value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `topicId` (path, string (Id), required) ID of the topic.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
### GET Topics Pinned Feed Elements
`GET /chatter/feeds/topics/{topicId}/pinned-feed-elements`
Operation ID: `get_connect_resource_feeds_topics_pin`. Tags: Topics Feed Resources.
Get pinned feed elements from a topic feed.
In the UI, pinned feed elements don’t show all auxiliary information, such as comments, likes, interaction counts, or read by information. As a result, the Pinned Feed Element Collection doesn’t include all the information for these capabilities.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/topics/{topicId}/pinned-feed-elements`
_Available in: v41.0_
Returns the same response body as the [GET /chatter/feeds/record/{recordId}/pinned-feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Record-Feed-Resources/operation/get_connect_resource_feeds_record_pin) operation. See that operation for the full response schema.
#### Parameters
* `topicId` (path, string (Id), required) ID of the topic.
#### Responses
* **200** _Pinned Feed Element Collection_ Collection of pinned feed elements.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/record/{recordId}/pinned-feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Record-Feed-Resources/operation/get_connect_resource_feeds_record_pin) operation. See that operation for the full response schema.
### PATCH Topics Pinned Feed Elements
`PATCH /chatter/feeds/topics/{topicId}/pinned-feed-elements`
Operation ID: `patch_connect_resource_feeds_topics_pin`. Tags: Topics Feed Resources.
Pin or unpin a feed element to a topic feed.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/topics/{topicId}/pinned-feed-elements`
_Available in: v41.0_
#### Parameters
* `topicId` (path, string (Id), required) ID of the topic.
#### Request body
Media type: `application/json`. Schema: `PinCapabilityInput`.
_Example: example\_1_ Payload 1
```
{
"entityId": "0D5B000000TW7uh",
"isPinned": "true"
}
```
#### Responses
* **200** _Pin Capability_ Success
Media type: `application/json`. Schema: `PinCapability`.
### GET User Profile Feed URL
`GET /chatter/feeds/user-profile/{userId}`
Operation ID: `get_connect_resource_feeds_user_profile__cc_user-profile_feed_url`. Tags: User Profile Feed Resources.
Returns a URL to the feed elements for the user profile feed.
**Note**: To match the feed displayed in the Chatter UI, the composition of this feed may change between releases.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/user-profile/{userId}`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `userId` (path, string (Id), required) ID of the user.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET User Profile Feed Elements
`GET /chatter/feeds/user-profile/{userId}/feed-elements`
Operation ID: `get_connect_resource_feeds_user_profile__cc_user_profile_feed_elements`. Tags: User Profile Feed Resources.
Returns feed elements created by the user, parented by the user, and where the user is mentioned. In Experience Cloud sites only, this feed also contains feed elements on which the user commented. You can get another user’s user profile feed.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feeds/user-profile/{userId}/feed-elements`
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `density` (query, string)
The density of the feed. One of these values:
* `AllUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations.
* `FewerUpdates` —Displays all updates from people and records the user follows and groups the user is a member of. Also displays custom recommendations, but hides some system-generated updates from records.
The default value is `AllUpdates`.
_Available in: v31.0_
* `elementsPerBundle` (query, integer)
Maximum number of feed elements to include in a bundle. The value must be an integer between 0 and 10. The default value is 3.
Bundled posts contain feed-tracked changes and are in record feeds only.
_Available in: v31.0_
* `filter` (query, string)
Valid values are `CommunityScoped` and `AuthoredBy`.
_Available in: v34.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`.
_Available in: v31.0_
* `pageSize` (query, integer)
Specifies the number of feed elements per page. Valid values are from 1 through 100. The default value is 25.
_Available in: v31.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v31.0_
* `recentCommentCount` (query, integer)
Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.
_Available in: v31.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v31.0_
* `threadedCommentsCollapsed` (query, boolean)
Specifies whether to return threaded comments in a collapsed style (`true`) or not (`false`). If you don’t specify a value, the default is `false`.
_Available in: v44.0_
* `userId` (path, string (Id), required) ID of the user.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# A generated token that indicates the view of feed elements in the feed. Page
# tokens are returned as part of the response body, in one of the URL
# parameters, such as nextPageURL:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Experience Cloud Site Direct Message Moderation Feed URL
`GET /connect/communities/{communityId}/chatter/feeds/direct-message-moderation`
Operation ID: `get_connect_resource_feeds_direct_messages_moderation__direct_message_moderation_feed_url`. Tags: Experience Cloud Site Direct Message Moderation Feed Resources.
Get the URL to the direct message moderation feed and a page of feed elements. This feed is available only to users with Moderate Experiences Chatter Messages permissions.
_Available in: v40.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `pageSize` (query, integer) Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in 0, feed elements aren’t returned with the feed.
* `recentCommentCount` (query, integer) Maximum number of comments to return with each feed element. The default value is 3.
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc`.
* `communityId` (path, string (Id), required) ID of an Experience Cloud site.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Experience Cloud Sites Direct Message Moderation Feed Elements
`GET /connect/communities/{communityId}/chatter/feeds/direct-message-moderation/feed-elements`
Operation ID: `get_connect_resource_feeds_direct_messages_moderation__direct_message_moderation_feed_elements`. Tags: Experience Cloud Site Direct Message Moderation Feed Resources.
Get all the direct messages that are flagged for moderation. This feed is available only to users with Moderate Experiences Chatter Messages permissions.
_Available in: v40.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed.
Page tokens are returned as part of the response body in one of the URL parameters, such as `nextPageURL`.
_Available in: v40.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are from 1 through 100. If you don't specify a size, the default is 25.
_Available in: v40.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v40.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v40.0_
* `communityId` (path, string (Id), required) ID of an Experience Cloud site.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# Page tokens are returned as part of the response body in one of the URL
# parameters, such as nextPageURL:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Experience Cloud Site Home Feed URL
`GET /connect/communities/{communityId}/chatter/feeds/home`
Operation ID: `get_connect_resource_feeds_communities_home__communities_home_feed_url`. Tags: Experience Cloud Site Home Feed Resources.
Get the URL to the Experience Cloud site home feed and a page of feed elements.
_Available in: v32.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `pageSize` (query, integer) Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in 0, feed elements aren’t returned with the feed.
* `recentCommentCount` (query, integer) Maximum number of comments to return with each feed element. The default value is 3.
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc`.
* `communityId` (path, string (Id), required) ID of an Experience Cloud site.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Experience Cloud Site Home Feed Elements
`GET /connect/communities/{communityId}/chatter/feeds/home/feed-elements`
Operation ID: `get_connect_resource_feeds_communities_home__home_feed_elements_title`. Tags: Experience Cloud Site Home Feed Resources.
Get all feed elements from the Experience Cloud site home feed.
_Available in: v32.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `filter` (query, string)
Filter value for a feed.
* `AllQuestions` —Feed elements that are questions.
* `AuthoredBy` —Feed elements authored by the user profile owner. This value is valid only for the `UserProfile` feed.
* `CommunityScoped` —Feed elements that are scoped to Experience Cloud sites. Currently, these feed elements have a User or a Group parent record. However, other parent record types could be scoped to sites in the future. Feed elements that are always visible in all sites are filtered out. This value is valid only for the `UserProfile` feed.
* `QuestionsWithCandidateAnswers` — Feed elements that are questions that have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `QuestionsWithCandidateAnswersReviewedPublished` — Feed elements that are questions that have candidate answers that have been reviewed or published. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `Read` —Feed elements that are older than 30 days or are marked as read for the context user. Includes existing feed elements when the context user joined the group. This value is valid only for the `Record` feed of a group.
* `SolvedQuestions` —Feed elements that are questions and that have a best answer.
* `UnansweredQuestions` —Feed elements that are questions and that don’t have any answers.
* `UnansweredQuestionsWithCandidateAnswers` — Feed elements that are questions that don’t have answers but have candidate answers associated with them. This value is valid only for users with the Access Einstein-Generated Answers permission.
* `Unread` —Feed elements that are created in the past 30 days and aren’t marked as read for the context user. This value is valid only for the `Record` feed of a group.
* `UnsolvedQuestions` —Feed elements that are questions and that don’t have a best answer.
_Available in: v32.0_
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`.
When the `sort` parameter is `MostViewed`, the `page` parameter can’t be used.
_Available in: v29.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are between 1 and 100. If you don't specify a size, the default is 25.
When the `sort` parameter is `MostViewed`, the `pageSize` must be a value from 1 to 25.
_Available in: v29.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v29.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v29.0_
* `threadedCommentsCollapsed` (query, boolean)
Specifies whether to return threaded comments in a collapsed style (`true`) or not (`false`). If you don’t specify a value, the default is `false`.
_Available in: v44.0_
* `communityId` (path, string (Id), required) ID of an Experience Cloud site.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# A generated token that indicates the view of feed elements in the feed. Page
# tokens are returned as part of the response body, in one of the URL
# parameters, such as nextPageURL, for example:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Experience Cloud Site Moderation Feed URL
`GET /connect/communities/{communityId}/chatter/feeds/moderation`
Operation ID: `get_connect_resource_feeds_communities_moderation__communities_moderation_feed_url`. Tags: Experience Cloud Site Moderation Feed Resources.
If the context user has the Moderate Experiences Feeds permission, this resource returns the URL to the Experience Cloud site moderation feed and a page of feed elements.
_Available in: v32.0_
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
#### Parameters
* `pageSize` (query, integer) Specifies the number of feed elements per page. Valid values are from 1 through 100. If you pass in 0, feed elements aren’t returned with the feed.
* `recentCommentCount` (query, integer) Maximum number of comments to return with each feed element. The default value is 3.
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc`.
* `communityId` (path, string (Id), required) ID of an Experience Cloud site.
#### Responses
* **200** Success
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feeds/news/{userId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/News-Feed-Resources/operation/get_connect_resource_feeds_news__cc_news_feed_url) operation. See that operation for the full response schema.
### GET Experience Cloud Site Moderation Feed Elements
`GET /connect/communities/{communityId}/chatter/feeds/moderation/feed-elements`
Operation ID: `get_connect_resource_feeds_communities_moderation__moderation_feed_elements_title`. Tags: Experience Cloud Site Moderation Feed Resources.
If the context user has the Moderate Experiences Feeds permission, this resource returns a list of all feed elements and comments in the Experience Cloud site that have been flagged by site members.
_Available in: v31.0_
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Parameters
* `page` (query, string)
A generated token that indicates the view of feed elements in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as `nextPageURL`.
_Available in: v29.0_
* `pageSize` (query, integer)
Specifies the number of elements per page. Valid values are between 1 and 100. If you don't specify a size, the default is 25.
_Available in: v29.0_
* `q` (query, string)
One or more keywords to search for in the body and comments of feed elements in this feed.
The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See [Wildcards](/docs/platform/connect-rest-api/guide/intro_wildcards).
_Available in: v29.0_
* `sort` (query, string)
Order of feed items in the feed.
* `CreatedDateAsc` — Sorts by oldest creation date. This sort order is available only for `DirectMessageModeration`, `Draft`, `Isolated`, `Moderation`, and `PendingReview` feeds.
* `CreatedDateDesc` —Sorts by most recent creation date.
* `LastModifiedDateDesc` —Sorts by most recent activity.
* `MostViewed` —Sorts by most viewed content. This sort order is available only for `Home` feeds when the `ConnectApi.FeedFilter` is `UnansweredQuestions`.
* `Relevance` —Sorts by most relevant content. This sort order is available only for `Company`, `Home`, and `Topics` feeds.
The default value is `CreatedDateDesc` .
_Available in: v29.0_
* `communityId` (path, string (Id), required) ID of an Experience Cloud site.
#### Responses
* **200** _Feed Element Page_ Container of feed elements with paginated results.
Media type: `application/json`. Schema: `object`.
Returns the same response body as the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation. See that operation for the full response schema.
#### Code samples
_Example: Example · HTTP_
```
# A generated token that indicates the view of feed elements in the feed. Page
# tokens are returned as part of the response body, in one of the URL
# parameters, such as nextPageURL, for example:
"nextPageUrl":
"/services/data/v/
chatter/feeds/news/
005D0000001GLowIAN
/feed-elements
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
```
### GET Feed Elements Capability, Topics
`GET /chatter/feed-elements/{feedElementId}/capabilities/topics`
Operation ID: `getTopicsCapability`. Tags: Feed Elements Resources.
Used to access and modify topics associated with a specific feed element.
Get topics associated with a feed element.
If the feed element doesn’t support this capability, the response is [404: Not Found](/docs/platform/connect-rest-api/guide/connect_error_responses).
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/topics`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of the feed element.
#### Responses
* **200** _Topics Capability_ If a feed element has this capability, the context user can add topics to it. Topics help users organize and discover conversations.
Media type: `application/json`. Schema: `TopicsCapabilitySbi`.
### POST Feed Elements Capability, Topics
`POST /chatter/feed-elements/{feedElementId}/capabilities/topics`
Operation ID: `postTopicsCapability`. Tags: Feed Elements Resources.
Used to access and modify topics associated with a specific feed element.
Post topics associated with a feed element.
If the feed element doesn’t support this capability, the response is [404: Not Found](/docs/platform/connect-rest-api/guide/connect_error_responses).
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/topics`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of the feed element.
* `topicId` (query, string)
ID of an existing topic.
Required for existing topics if the `topicName` property isn’t used.
_Available in: v32.0_
* `topicName` (query, string)
Name of a new or existing topic, up to 150 characters.
Required for new topics; required for existing topics if the `topicId` property isn’t used.
_Available in: v32.0_
#### Request body
Feed item topic input.
_Available in: v32.0_
Media type: `application/json`. Schema: `FeedItemTopicsInput`.
_Example: example\_1_ Payload 1
The following example attaches a new topic to a feed item:
```
{
"topicName": "W3C"
}
```
#### Responses
* **200** _Topic_ Topic.
Media type: `application/json`. Schema: `TopicSbi`.
### DELETE Feed Elements Capability, Topics
`DELETE /chatter/feed-elements/{feedElementId}/capabilities/topics`
Operation ID: `deleteTopicsCapability`. Tags: Feed Elements Resources.
Used to access and modify topics associated with a specific feed element.
Delete topics associated with a feed element.
#### Experience Cloud site path
`/connect/communities/{communityId}/chatter/feed-elements/{feedElementId}/capabilities/topics`
_Available in: v32.0_
#### Parameters
* `feedElementId` (path, string (Id), required) ID of the feed element.
* `topicId` (query, string, required)
An existing topic ID.
_Available in: v32.0_
#### Responses
* **200** Success
## Schemas
### Batch
Result of an entire batch request operation. Results are ordered in the same order in which the requests were given. Results may either be a successful result with a response body, a successful result without a response body, or an error result without a response body. Success and error are determined by the status code in each result.
* `hasErrors` (_boolean_)
True if at least one of the results is an error (a status code in the 400 or 500 range).
_Available in: v28.0_
_Filter group: Small_
* `results` (_array of BatchResultItem_)
Collection of batch result items. One for each request input.
_Available in: v23.0_
_Filter group: Small_
### Comment
A comment.
* `body` (_object_)
FeedItemBody
Message body for the comment.
_Available in: v23.0_
_Filter group: Small_
Includes all fields of `FeedItemBody`.
* `capabilities` (_object_)
CommentCapabilities
Capabilities associated with the comment.
_Available in: v32.0_
_Filter group: Medium_
Includes all fields of `CommentCapabilities`.
* `clientInfo` (_object_)
ClientInfo
Information about the client app used to authenticate the connection.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `ClientInfo`.
* `createdDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z .
_Available in: v23.0_
_Filter group: Small_
* `feedElement` (_object_)
Reference
Feed element on which the comment is posted.
_Available in: v32.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `id` (_string (Id)_)
18-character ID of the comment.
_Available in: v23.0_
_Filter group: Small_
* `isDeleteRestricted` (_boolean_)
Returns `true` if the context user can’t delete the comment. If it returns `false`, possibly the context user can delete the comment.
_Available in: v25.0_
_Filter group: Medium_
* `likes` (_object_)
LikePage
Page of likes associated with the comment.
This property has no information for comments on direct messages.
_Available in: v24.0_
_Filter group: Medium_
Includes all fields of `LikePage`.
* `likesMessage` (_object_)
LikeMessageBody
Message body that describes who likes the comment.
This property is `null` for comments on direct messages.
_Available in: v27.0_
_Filter group: Medium_
Includes all fields of `LikeMessageBody`.
* `moderationFlags` (_object_)
ModerationFlags
Flags for this comment. Moderators can view and act on flagged items.
If the `communityModeration` property of the Features response body is `false`, this property is `null`.
Includes all fields of `ModerationFlags`.
* `myLike` (_object_)
Reference
If the context user liked the comment, returns a reference to that like or returns `null`.
This property is `null` for comments on direct messages.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `parent` (_object_)
Reference
Information about the parent of the feed-item associated with this comment.
_Available in: v23.0_
_Filter group: Big_
Includes all fields of `ReferenceCore`.
* `relativeCreatedDate` (_string_)
Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.”
_Available in: v28.0_
_Filter group: Medium_
* `threadLevel` (_integer_)
Level of nesting for a comment. 0 indicates a standard comment with a parent post. 1 indicates a threaded comment with a parent comment and a parent post. 2 indicates a threaded comment with two parent comments and a parent post. The UI is limited to these three levels.
_Available in: v44.0_
_Filter group: Small_
* `threadParentId` (_string (Id)_)
ID of the parent comment for a threaded comment.
_Available in: v44.0_
_Filter group: Small_
* `type` (_object_)
ConnectCommentTypeEnum
Indicates the type of comment. Valid values are:
* `ContentComment` — the comment contains an attachment
* `TextComment` — the comment contains only text
_Available in: v24.0_
_Filter group: Small_
Includes all fields of `ConnectCommentTypeEnum`.
* `url` (_string (url)_)
URL to this comment.
_Available in: v23.0_
_Filter group: Small_
* `user` (_object_)
UserSummary
Information about the comment author.
_Available in: v23.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
* `attachment` (_string_)
If the comment does not contain an attachment or if the attachment, returns `null`. Otherwise, returns Feed Item Attachment: Content .
**Important**: As of version 32.0, use the `capabilities` property.
_Available in: v24.0–31.0_
_Filter group: Medium_
* `feedItem` (_object_)
ReferenceCore
Feed item on which the comment is posted.
**Important**: As of version 32.0, use the `feedElement` property.
_Available in: v23.0–31.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `isDeletable` (_boolean_)
**Note**: This property is no longer available as of version 25.0. Use the `isDeleteRestricted` property instead.
Specifies if the context user can delete the comment.
_Available in: v23.0–24.0_
### CommentInput
A comment.
* `body` (_object_, required)
MessageBodyInput
The body of the comment.
Feed item and comment bodies have a 10,000 character limit. Because this limit can change, we recommend that clients make a `describeSObjects()` call on the FeedItem or FeedComment object. To determine the maximum number of allowed characters, look at the length of the Body or CommentBody field.
To edit this property in a comment, make a PATCH request to `/chatter/comments/{commentId}`. Editing comments is supported in version 34.0 and later.
Rich text and inline images are supported in comment bodies in version 35.0 and later. Inline images in content bodies must use content document (069) image files previously uploaded to Salesforce. Entity links are supported in version 43.0 and later.
_Available in: v23.0_
Includes all fields of `MessageBodyInput`.
* `capabilities` (_object_)
CommentCapabilitiesInput
Capabilities of the comment, such as a file attachment.
You can edit a comment’s body, but you can’t update a comment’s capabilities.
_Available in: v32.0_
Includes all fields of `CommentCapabilitiesInput`.
* `threadParentId` (_string_)
ID of the parent comment for a threaded comment.
_Available in: v44.0_
* `attachment` (_string_)
Values are:
* Attachment Input: Existing Content
* Attachment Input: New File Upload
**Important**: As of version 32.0, use the `capabilities` property.
_Available in: v24.0–31.0_
### FeedEntityIsEditable
Indicates whether the context user can edit a feed element or comment.
* `areAttachmentsEditableByMe` (_boolean_)
`true` if the context user can add and remove attachments on the feed element or comment, `false` otherwise.
_Available in: v36.0_
_Filter group: Small_
* `feedEntityUrl` (_string (url)_)
URL of the feed element or comment.
_Available in: v34.0_
_Filter group: Small_
* `isEditableByMe` (_boolean_)
`true` if the context user can edit the feed element or comment, `false` otherwise.
_Available in: v34.0_
_Filter group: Small_
### StatusCapability
If a feed post or comment has this capability, it has a status that determines its visibility.
* `feedEntityStatus` (_object_)
ConnectFeedEntityStatusEnum
Status of the feed post or comment. Values are:
* `Draft` — The feed post isn’t published but is visible to the author and users with Modify All Data or View All Data permission. Comments can’t be drafts.
* `Isolated` — The feed post or comment is isolated, and only admins can see it.
* `PendingReview` — The feed post or comment isn’t approved yet and therefore isn’t published or visible.
* `Published` — The feed post or comment is approved and visible.
_Available in: v37.0_
_Filter group: Small_
Includes all fields of `ConnectFeedEntityStatusEnum`.
* `isApprovableByMe` (_boolean_)
Specifies whether the context user can change the status of the feed post or comment.
_Available in: v37.0_
_Filter group: Small_
### ConnectFeedEntityStatusEnum
Describes the status of a feed item
Type: `string`.
Allowed values: `Draft`, `Isolated`, `PendingReview`, `Published`.
### StatusCapabilityInput
Change the status of a feed post or comment.
* `feedEntityStatus` (_object_)
ConnectFeedEntityStatusEnum
Status of the feed post or comment. Values are:
* `Draft` — The feed post isn’t published but is visible to the author and users with Modify All Data or View All Data permission. Comments can’t be drafts.
* `Isolated` — The feed post or comment is isolated, and only admins can see it.
* `PendingReview` — The feed post or comment isn’t approved yet and therefore isn’t published or visible.
* `Published` — The feed post or comment is approved and visible.
Posts that have a status of `PendingReview` or `Published` can’t be changed to a status of `Draft` and vice versa. Only admins can change the status of a post or comment to or from `Isolated` status.
You must specify `feedEntityStatus` in a query parameter or a request body schema.
_Available in: v37.0_
Includes all fields of `ConnectFeedEntityStatusEnum`.
### UpDownVoteCapability
If a feed post or comment has this capability, users can upvote or downvote it.
* `downVoteCount` (_integer (int64)_)
Number of downvotes.
_Available in: v41.0_
_Filter group: Small_
* `myVote` (_object_)
ConnectUpDownVoteValueEnum
Specifies the context user’s vote.
_Available in: v41.0_
_Filter group: Small_
Includes all fields of `ConnectUpDownVoteValueEnum`.
* `upVoteCount` (_integer (int64)_)
Number of upvotes.
_Available in: v41.0_
_Filter group: Small_
### ConnectUpDownVoteValueEnum
Type of vote for a feed element or comment.
_Available in: v42.0_
_Filter group: Small_
Type: `string`.
Allowed values: `Down`, `None`, `Up`.
### UpDownVoteCapabilityInput
Upvote or downvote a feed element or a comment.
* `vote` (_object_)
ConnectUpDownVoteValueEnum
Type of vote for a feed element or comment.
You must specify `vote` in a query parameter or a request body schema.
_Available in: v41.0_
Includes all fields of `ConnectUpDownVoteValueEnum`.
### VoteCollection
A collection of upvotes or downvotes for a feed element or comment.
* `currentPageToken` (_integer_)
Token identifying the current page.
_Available in: v42.0_
_Filter group: Medium_
* `currentPageUrl` (_string (url)_)
Connect REST API URL identifying the current page.
_Available in: v42.0_
_Filter group: Medium_
* `items` (_array of Vote_)
Collection of users and their upvotes or downvotes.
Upvotes include likes and upvotes. For example, if a post receives five likes and three upvotes, the number of upvotes is eight. For this reason, the collection of users and their upvotes also includes users who liked the post or comment. If a user both liked and upvoted a post, they appear only once in the collection.
_Available in: v42.0_
_Filter group: Small_
* `nextPageToken` (_integer_)
Token identifying the next page, or `null` if there isn’t a next page.
_Available in: v42.0_
_Filter group: Small_
* `nextPageUrl` (_string (url)_)
Connect REST API URL identifying the next page, or `null` if there isn’t a next page.
_Available in: v42.0_
_Filter group: Small_
* `previousPageToken` (_integer_)
Token identifying the previous page, or `null` if there isn’t a previous page.
_Available in: v42.0_
_Filter group: Medium_
* `previousPageUrl` (_string (url)_)
Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page.
_Available in: v42.0_
_Filter group: Medium_
* `total` (_integer (int64)_)
Total number of upvotes or downvotes for the feed element or comment.
The number of upvotes includes the number of likes and upvotes. For example, if a post receives five likes and three upvotes, the total number of upvotes is eight. If a user both liked and upvoted a post, we count that as two upvotes.
_Available in: v42.0_
_Filter group: Small_
### VerifiedCapability
If a comment has this capability, users with permission can mark it as verified or unverified.
* `isVerifiableByMe` (_boolean_)
Specifies whether the context user has permission to mark comments as verified or unverified (`true`) or not (`false`).
_Available in: v41.0_
_Filter group: Small_
* `isVerified` (_boolean_)
Specifies whether the comment is marked as verified (`true`) or not (`false`).
_Available in: v41.0_
_Filter group: Small_
* `isVerifiedByAnonymized` (_boolean_)
Specifies whether the comment is marked as verified by an anonymous user (`true`) or not (`false`). If the comment has never been marked as verified or unverified, `null`. Also `null` if the context user doesn’t have permission to mark comments as verified or unverified.
_Available in: v43.0_
_Filter group: Small_
* `lastVerifiedByUser` (_object_)
UserSummary
User who last marked the comment as verified or unverified, otherwise `null`. Also `null` if the context user doesn’t have permission to mark comments as verified or unverified.
_Available in: v41.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
* `lastVerifiedDate` (_string (date-time)_)
ISO 8601 date string. Date when the comment was last marked as verified or unverified, otherwise `null`. Also `null` if the context user doesn’t have permission to mark comments as verified or unverified.
_Available in: v41.0_
_Filter group: Small_
### VerifiedCapabilityInput
Mark a comment as verified or unverified.
* `isVerified` (_boolean_)
Specifies whether to mark the comment as verified (`true`) or unverified (`false`).
Only verified comments can be marked as unverified, and only unverified comments can be marked as verified.
You must specify `isVerified` in a query parameter or a request body schema.
_Available in: v41.0_
* `isVerifiedByAnonymized` (_boolean_)
Specifies whether to mark the comment as verified by an anonymous user (`true`).
If a user previously verified a comment and then requested the activity to be deleted, use `isVerifiedByAnonymized` to maintain the verification and anonymize the value of `lastVerifiedByUser`.
You can’t set `isVerified` and `isVerifiedByAnonymized` to `true` at the same time. `isVerifiedByAnonymized` can be set to `true` only if `isVerified` is already set to `true`.
You can’t set `isVerifiedByAnonymized` to `false`. After `isVerifiedByAnonymized` is set to `true`, it can be undone only when another user marks the comment as unverified and then reverifies the comment.
_Available in: v43.0_
### LikePage
Page of Chatter likes.
* `currentPageToken` (_string_)
Token identifying the current page.
_Available in: v37.0_
_Filter group: Medium_
* `currentPageUrl` (_string_)
URL to the current page of likes.
_Available in: v23.0_
_Filter group: Medium_
* `items` (_array of Like_)
Collection of likes.
_Available in: v32.0_
_Filter group: Small_
* `likes` (_array of Like_)
Collection of likes.
**Important**: As of API version 32.0, use the `items` property.
_Available in: v23.0–31.0_
_Filter group: Small_
* `myLike` (_object_)
ReferenceCore
**Note**: This field is no longer available as of version 24.0.
Either returns a reference to the specific like or returns `null`.
_Available in: v23.0–24.0_
Includes all fields of `ReferenceCore`.
* `nextPageToken` (_string_)
Token identifying the next page, or `null` if there isn’t a next page.
_Available in: v37.0_
_Filter group: Small_
* `nextPageUrl` (_string_)
URL to the next page of likes.
_Available in: v23.0_
_Filter group: Small_
* `previousPageToken` (_string_)
Token identifying the previous page, or `null` if there isn’t a previous page.
_Available in: v37.0_
_Filter group: Medium_
* `previousPageUrl` (_string_)
URL to the previous page of likes.
_Available in: v23.0_
_Filter group: Medium_
* `total` (_integer_)
Total number of likes for the item.
_Available in: v23.0_
_Filter group: Small_
### Like
Chatter like.
* `id` (_string (Id)_)
18-character ID of the like
_Available in: v23.0_
_Filter group: Small_
* `likedItem` (_object_)
Reference
A reference to the liked comment or feed element
_Available in: v27.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `url` (_string (url)_)
URL to this like
_Available in: v23.0_
_Filter group: Small_
* `user` (_object_)
UserSummary
Information about the user who liked this comment or feed element
_Available in: v23.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
### ConnectFeedSortOrder
Sort order for the feed specified in `redirectedFeedType`. Otherwise, `null`.
_Available in: v42.0_
_Filter group: Small_
Type: `string`.
Allowed values: `CreatedDateAsc`, `CreatedDateDesc`, `LastModifiedDateDesc`, `MostViewed`, `Relevance`.
### FeedElementPage
Container of feed elements with paginated results.
* `currentPageToken` (_string_)
Token identifying the current page.
_Available in: v37.0_
_Filter group: Medium_
* `currentPageUrl` (_string_)
Connect REST API URL identifying the current page.
_Available in: v31.0_
_Filter group: Medium_
* `elements` (_array of object_)
Collection of feed elements. A feed element can be any of these:
* Generic Feed Element
* Feed Item
_Available in: v31.0_
_Filter group: Small_
See the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
Each item: See the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `isModifiedToken` (_string_)
An opaque polling token that describes when a news feed was last modified. Use this as the value in the `{since}` request parameter of the `/chatter/feeds/news/me/feed-elements/is-modified` resource.
This feature is available through a Feed Polling pilot program. This pilot program is closed and not accepting new participants.
_Available in: v31.0_
_Filter group: Medium_
* `isModifiedUrl` (_string_)
Connect REST API URL with a `{since}` request parameter that contains an opaque token that describes when the feed was last modified. Returns `null` if the feed isn’t a news feed. Use this URL to poll a news feed for updates.
This feature is available through a Feed Polling pilot program. This pilot program is closed and not accepting new participants.
_Available in: v31.0_
_Filter group: Medium_
* `nextPageToken` (_string_)
Page token to access the next page of feed elements.
_Available in: v31.0_
_Filter group: Small_
* `nextPageUrl` (_string_)
Connect REST API URL identifying the next page, or `null` if there isn’t a next page.
_Available in: v31.0_
_Filter group: Small_
* `updatesToken` (_string_)
Token to use in an updatedSince parameter, or `null` if not available. An opaque polling token that describes when a news feed was last modified. Use this token as the value in the updatedSince request parameter of the `/chatter/feeds/news/me/feed-elements` resource.
_Available in: v31.0_
_Filter group: Big_
* `updatesUrl` (_string_)
A resource with the feed elements updated since the feed was refreshed. Value is `null` if the feed doesn’t support updates polling.
_Available in: v31.0_
_Filter group: Big_
### ConnectFeedElementTypeEnum
The type of feed element this input represents.
The only valid value is `FeedItem`.
Required when creating a feed item (POST). Optional when updating a feed item (PATCH)
_Available in: v31.0_
Type: `string`.
Allowed values: `Bundle`, `FeedItem`, `Recommendation`.
### ConnectFeedItemVisibilityEnum
Specifies the type of users who can see a feed item.
Type: `string`.
Allowed values: `AllUsers`, `InternalUsers`.
### FeedElementCapabilitySetInput
A container for all capabilities that can be included when creating a feed element.
In API version 30.0 and earlier, most feed items can have comments, likes, topics, and so on. In version 31.0 and later, every feed item (and feed element) can have a unique set of capabilities. If a capability property exists on a feed element, that capability is available, even if the capability property doesn’t have a value. For example, if the `ChatterLikes` capability property exists on a feed element (with or without a value), the context user can like that feed element. If the capability property doesn’t exist, it isn’t possible to like that feed element. A capability can also contain associated data. For example, the `Moderation` capability contains data about moderation flags.
#### XML example
```
0Agxx00000000d1CAA
0Agxx00000000d2DFY
false
069D00000001IOh
069D00000002IOg
```
* `associatedActions` (_object_)
AssociatedActionsCapabilityInput
Describes action links that can be created or updated on a feed element. To associate an action link group with a feed element, the client must be the same client app that created the action link group definition and the user must either be the user who created the definition or have View all Data permission.
_Available in: v31.0_
Includes all fields of `AssociatedActionsCapabilityInput`.
* `bookmarks` (_object_)
BookmarksCapabilityInput
Create or update a bookmark on a feed element.
_Available in: v32.0_
Includes all fields of `BookmarksCapabilityInput`.
* `canvas` (_object_)
CanvasCapabilityInput
Create or update a canvas app associated with a feed element.
_Available in: v32.0_
Includes all fields of `CanvasCapabilityInput`.
* `content` (_object_)
ContentCapabilityInput
Attach or update a file on a comment. Use this class to attach a new file or update a file that has already been uploaded to Salesforce.
This request body isn’t available for feed posts in version 36.0 and later. In version 36.0 and later, use.
_Available in: v32.0–35.0_
Includes all fields of `ContentCapabilityInput`.
* `directMessage` (_object_)
DirectMessageCapabilityInput
Create or update the members of a direct message.
_Available in: v39.0_
Includes all fields of `DirectMessageCapabilityInput`.
* `extensions` (_object_)
ExtensionsCapabilityInput
Create or update extensions associated with a feed element.
_Available in: v40.0_
Includes all fields of `ExtensionsCapabilityInput`.
* `feedEntityShare` (_object_)
FeedEntityShareCapabilityInput
Share a feed entity with a feed post or comment.
_Available in: v39.0_
Includes all fields of `FeedEntityShareCapabilityInput`.
* `files` (_object_)
MultipleContentCapabilityInput
Attach up to 10 files that have already been uploaded or remove one or more files from a feed element.
_Available in: v36.0_
Includes all fields of `MultipleContentCapabilityInput`.
* `link` (_object_)
LinkCapabilityInput
Create or update a link attached to a feed element.
_Available in: v32.0_
Includes all fields of `LinkCapabilityInput`.
* `poll` (_object_)
PollCapabilityInput
Create or vote on a poll feed element.
_Available in: v32.0_
Includes all fields of `PollCapabilityInput`.
* `questionAndAnswers` (_object_)
QuestionAndAnswersCapabilityInput
Create or edit a question feed element or set the best answer of the existing question feed element.
_Available in: v32.0_
Includes all fields of `QuestionAndAnswersCapabilityInput`.
* `status` (_object_)
StatusCapabilityInput
Change the status of a feed post or comment.
_Available in: v44.0_
Includes all fields of `StatusCapabilityInput`.
* `topics` (_object_)
TopicsCapabilityInput
Assign topics to a feed element.
_Available in: v38.0_
Includes all fields of `TopicsCapabilityInput`.
### AbstractFeedElementInput
Description of a feed element input.
* `capabilities` (_object_)
FeedElementCapabilitySetInput
The capabilities that define the behavior of this feed element.
_Available in: v31.0_
Includes all fields of `FeedElementCapabilitySetInput`.
* `feedElementType` (_object_)
ConnectFeedElementTypeEnum
The type of feed element this input represents.
The only valid value is `FeedItem`.
Required when creating a feed item (POST). Optional when updating a feed item (PATCH)
_Available in: v31.0_
Includes all fields of `ConnectFeedElementTypeEnum`.
* `subjectId` (_string_, required)
The ID of the parent this feed element is being posted to. This value can be the ID of a user, group, or record, or the string `me` to indicate the context user.
In version 45.0 and later, you can move a feed element from one public group to another by setting this property to the ID of the new public group. You can’t include or change any other properties when moving a feed element.
_Available in: v31.0_
* `attachment` (_string_)
You can specify only one of these values in the attachment parameter. Values are:
* Attachment Input: Canvas App (v29.0–31.0)
* Attachment Input: Existing Content (v23.0–31.0)
* Attachment Input: Feed Poll (v26.0–31.0)
* Attachment Input: Link (v23.0–31.0)
* Attachment Input: New File Upload (v23.0–31.0)
**Important**: As of API version 32.0, use the `capabilities` property.
* `body` (_string_)
Description of message body. Feed item and comment bodies have a 10,000 character limit. Because this limit can change, we recommend that clients make a `describeSObjects()` call on the FeedItem or FeedComment object. To determine the maximum number of allowed characters, look at the length of the Body or CommentBody field. The body can contain up to 25 mentions.
If you specify `originalFeedElementId` to share a feed item, use the `body` property to add the first comment to the feed item.
To edit this property in a feed item, make a PATCH request to `/chatter/feed-elements/{feedElementId}`. Editing feed posts is supported in version 34.0 and later.
Required unless the feed item has a content capability or a link capability
_Available in: v23.0_
* `isBookmarkedByCurrentUser` (_boolean_)
Specifies whether to bookmark the new feed item for the user (`true`) or not (`false`). The default value is `false`.
**Important**: As of API version 32.0, use the `capabilities.bookmarks.isBookmarkedByCurrentUser` property.
_Available in: v24.0–31.0_
* `originalFeedElementId` (_string_)
To share a feed element, specify its 18-character ID .
You can’t share a post and upload a file in the same request body.
In API version 39.0 and later, use the `capabilities.feedEntityShare.feedEntityId` property.
_Available in: v31.0–38.0_
* `originalFeedItemId` (_string_)
To share a feed item, specify its 18-character ID .
In API version 32.0–38.0, use the `originalFeedElementId` property. In API version 39.0 and later, use the `capabilities.feedEntityShare.feedEntityId` property.
_Available in: v24.0–31.0_
### ReadByCapabilityInput
Mark feed elements as read by the context user.
* `isReadByMe` (_boolean_)
Specifies to mark the feed element as read (`true`) for the context user.
You must specify `isReadByMe` in a query parameter or a request body.
_Available in: v40.0_
* `lastReadDateByMe` (_string (date-time)_)
Specifies the last date, in ISO 8601 format, when the feed element is marked as read for the context user. If you don’t specify a date or you specify a future date, the current system date is used.
_Available in: v40.0_
### ConnectFeedCommentSortOrder
Specifies the order returned by feed sorts.
Type: `string`.
Allowed values: `CreatedDateLatestAsc`, `CreatedDateOldestAsc`, `Relevance`.
### AbstractFeedElement
Since a Feed now contains more than Feed Items, let Feed Elements be the abstract object that all things in the Feed extend. Feed Items and Bundles are each Feed Elements. All Feed Elements have shared properties: id, feedElementType, body, and capabilities.
Discriminator: `feedElementType` selects the concrete type. Mapping: `FeedItem` → `FeedItem`, `Bundle` → `FeedElement`, `Recommendation` → `FeedElement`.
* `body` (_object_)
FeedItemBody
Information about the feed element.
_Available in: v22.0_
_Filter group: Small_
Includes all fields of `FeedItemBody`.
* `capabilities` (_object_)
A container for all capabilities that can be included with a feed element.
_Available in: v31.0_
_Filter group: Medium_
See the [GET /chatter/feed-elements/{feedElementId}/capabilities](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCapabilities) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `createdDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z
_Available in: v23.0_
_Filter group: Small_
* `feedElementType` (_object_)
ConnectFeedElementTypeEnum
Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values:
* `Bundle` — A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values.
* `FeedItem` — A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values.
* `Recommendation` — A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user.
_Available in: v31.0_
Includes all fields of `ConnectFeedElementTypeEnum`.
* `header` (_object_)
FeedItemBody
The header is the title of the post. This property contains renderable plain text for all the segments of the message. If a client doesn't know how to render a feed element type, it should render this text.
_Available in: v31.0_
_Filter group: Medium_
Includes all fields of `FeedItemBody`.
* `id` (_string (Id)_)
18-character ID of the feed item.
_Available in: v23.0_
_Filter group: Small_
* `modifiedDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z .
_Available in: v23.0_
_Filter group: Small_
* `parent` (_object_)
AbstractIdable
The parent of the feed element.
_Available in: v28.0_
_Filter group: Medium_
Includes all fields of `AbstractIdable`.
* `relativeCreatedDate` (_string_)
Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” .
_Available in: v28.0_
_Filter group: Small_
* `url` (_string (url)_)
URL to this feed item.
_Available in: v23.0_
_Filter group: Small_
### FeedElementCapabilitySet
A container for all capabilities that can be included with a feed element. If a capability value is null, that indicates that the capability can not exist on that feed element. If the capability exists but contains null values, then the feed element may have that capability's feature, but that it has not yet been applied. For example, a feed element with a null associated actions capability indicates that no actions may be added to that feed element, whereas an empty associated actions capability means that the feed element may have actions, but none have been provided. Note, that in REST, this output is treated in a special way: null values are not included in the output (effectively making this a traditional JSON map).
* `approval` (_object_)
ApprovalCapability
If a feed element has this capability, it includes information about an approval.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `ApprovalCapability`.
* `associatedActions` (_object_)
AssociatedActionsCapability
If a feed element has this capability, it has platform actions associated with it.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `AssociatedActionsCapability`.
* `banner` (_object_)
BannerCapability
If this feed element has this capability, it has a banner motif and style.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `BannerCapability`.
* `bookmarks` (_object_)
BookmarksCapability
If a feed element has this capability, the context user can bookmark it.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `BookmarksCapability`.
* `bundle` (_object_)
AbstractBundleCapability
If a feed element has this capability, the feed element may be a group of other feed elements condensed into one.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `AbstractBundleCapability`.
* `callCollaboration` (_object_)
CallCollaborationCapability
If a feed element has this capability, it has a recording comment.
_Available in: v51.0_
_Filter group: Small_
Includes all fields of `CallCollaborationCapability`.
* `canvas` (_object_)
CanvasCapability
If a feed element has this capability, it renders a canvas app.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `CanvasCapability`.
* `caseComment` (_object_)
CaseCommentCapability
If a feed element has this capability, it has a case comment on the case feed.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `CaseCommentCapability`.
* `chatterLikes` (_object_)
ChatterLikesCapability
If a feed element has this capability, the context user can like it. Exposes information about existing likes.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `ChatterLikesCapability`.
* `close` (_object_)
CloseCapability
If a feed element has this capability, users with permission can close it.
_Available in: v43.0_
_Filter group: Small_
Includes all fields of `CloseCapability`.
* `comments` (_object_)
CommentsCapability
If a feed element or comment has this capability, the context user can add a comment.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `CommentsCapability`.
* `dashboardComponentSnapshot` (_object_)
DashboardComponentSnapshotCapability
If a feed element has this capability, it has a dashboard component snapshot. A snapshot is a static image of a dashboard component at a specific point in time.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `DashboardComponentSnapshotCapability`.
* `directMessage` (_object_)
DirectMessageCapability
If a feed element has this capability, it’s a direct message.
_Available in: v39.0_
_Filter group: Small_
Includes all fields of `DirectMessageCapability`.
* `edit` (_object_)
EditCapability
If a feed element has this capability, users who have permission can edit it.
_Available in: v34.0_
_Filter group: Small_
Includes all fields of `EditCapability`.
* `emailMessage` (_object_)
EmailMessageCapability
If a feed element has this capability, it has an email message from a case.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `EmailMessageCapability`.
* `enhancedLink` (_object_)
EnhancedLinkCapability
If a feed element has this capability, it has a link that may contain supplemental information like an icon, a title, and a description.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `EnhancedLinkCapability`.
* `extensions` (_object_)
ExtensionsCapability
If a feed element has this capability, it has one or more extension attachments.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `ExtensionsCapability`.
* `feedEntityShare` (_object_)
If a feed element or comment has this capability, a feed entity is shared with it.
_Available in: v39.0_
_Filter group: Small_
See the [GET /chatter/feed-elements/{feedElementId}/capabilities/feed-entity-share](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedEntityShareCapability) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `files` (_object_)
MultipleContentCapability
If a feed element has this capability, it has one or more file attachments.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `MultipleContentCapability`.
* `interactions` (_object_)
InteractionsCapability
If a feed element has this capability, it has information about user interactions.
_Available in: v37.0_
_Filter group: Small_
Includes all fields of `InteractionsCapability`.
* `link` (_object_)
LinkCapability
If a feed element has this capability, it has a link.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `LinkCapability`.
* `mediaReferences` (_object_)
MediaReferenceCapability
If a feed element has this capability, it has one or more media references.
_Available in: v41.0_
_Filter group: Small_
Includes all fields of `MediaReferenceCapability`.
* `moderation` (_object_)
ModerationCapability
If a feed element has this capability, users in the Experience Cloud site can flag the feed element for moderation. This response body also includes information about the flagged content.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `ModerationCapability`.
* `mute` (_object_)
MuteCapability
If a feed element has this capability, users can mute it.
_Available in: v35.0_
_Filter group: Small_
Includes all fields of `MuteCapability`.
* `origin` (_object_)
OriginCapability
If a feed element has this capability, it was created by a feed action.
_Available in: v33.0_
_Filter group: Small_
Includes all fields of `OriginCapability`.
* `pin` (_object_)
PinCapability
If a feed element has this capability, users who have permission can pin it to a feed.
_Available in: v41.0_
_Filter group: Small_
Includes all fields of `PinCapability`.
* `poll` (_object_)
PollCapability
If a feed element has this capability, the feed element can include a poll for voting.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `PollCapability`.
* `questionAndAnswers` (_object_)
QuestionAndAnswersCapability
If a feed element has this capability, it has a question and comments on the feed element are answers to the question.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `QuestionAndAnswersCapability`.
* `readBy` (_object_)
ReadByCapability
If a feed element has this capability, the context user can mark it as read.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `ReadByCapability`.
* `recommendations` (_object_)
RecommendationsCapability
If a feed element has this capability, it has a recommendation.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `RecommendationsCapability`.
* `recordSnapshot` (_object_)
RecordSnapshotCapability
If a feed element has this capability, it contains all the snapshotted fields of a record for a single create record event.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `RecordSnapshotCapability`.
* `socialPost` (_object_)
SocialPostCapability
If a feed element has this capability, it can interact with a social post on a social network.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `SocialPostCapability`.
* `status` (_object_)
StatusCapability
If a feed post or comment has this capability, it has a status that determines its visibility.
_Available in: v37.0_
_Filter group: Small_
Includes all fields of `StatusCapability`.
* `topics` (_object_)
TopicsCapability
If a feed element has this capability, the context user can add topics to it. Topics help users organize and discover conversations.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `TopicsCapability`.
* `trackedChanges` (_object_)
TrackedChangesCapability
If a feed element has this capability, it contains all changes to a record for a single tracked change event.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `TrackedChangesCapability`.
* `upDownVote` (_object_)
UpDownVoteCapability
If a feed post or comment has this capability, users can upvote or downvote it.
_Available in: v41.0_
_Filter group: Small_
Includes all fields of `UpDownVoteCapability`.
### BookmarksCapability
If a feed element has this capability, the context user can bookmark it.
* `isBookmarkedByCurrentUser` (_boolean_)
Indicates whether the feed element has been bookmarked by the context user (`true`) or not (`false`).
_Available in: v32.0_
_Filter group: Small_
### BookmarksCapabilityInput
Create or update a bookmark on a feed element.
* `isBookmarkedByCurrentUser` (_boolean_)
Specifies if the feed element should be bookmarked for the user (`true`) or not (`false`).
You must specify `isBookmarkedByCurrentUser` in a query parameter or a request body.
_Available in: v32.0_
### AbstractBundleCapability
Existence of this capability on a Feed Element means the Feed Element may be a group of other Feed Elements condensed into one. The type of nesting depends on the bundle type.
Discriminator: `bundleType` selects the concrete type. Mapping: `GenericBundle` → `GenericBundleCapability`, `TrackedChanges` → `TrackedChangeBundleCapability`.
* `bundleType` (_object_)
ConnectBundleTypeEnum
Type of bundle.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `ConnectBundleTypeEnum`.
* `page` (_object_)
FeedElementCollection
A collection of feed elements.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `FeedElementCollection`.
* `totalElements` (_integer_)
The total number of feed elements that this bundle aggregates.
_Available in: v31.0_
_Filter group: Small_
### ChatterLikesCapability
If a feed element has this capability, the context user can like it. Exposes information about existing likes.
* `isLikedByCurrentUser` (_boolean_)
Indicates whether the feed element is liked by the context user (`true`) or not (`false`).
_Available in: v32.0_
_Filter group: Small_
* `likesMessage` (_object_)
LikeMessageBody
A message body that describes who likes the feed element.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `LikeMessageBody`.
* `myLike` (_object_)
Reference
If the context user has liked the feed element, this property is a reference to the specific like, `null` otherwise.
_Available in: v32.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `page` (_object_)
LikePage
Likes information for this feed element.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `LikePage`.
### CloseCapability
If a feed element has this capability, users with permission can close it.
Users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. If the closed feed element is a poll, users can’t vote on it. Users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer.
Admins and moderators can edit and delete closed feed elements and comments on closed feed elements. Admins and moderators can select or remove the best answer status on comments on closed feed elements.
* `canContextUserUpdateIsClosed` (_boolean_)
Specifies whether the context user has permission to set the feed element to closed (`true`) or not (`false`).
_Available in: v43.0_
_Filter group: Small_
* `isClosed` (_boolean_)
Specifies whether the feed element is closed (`true`) or not (`false`).
_Available in: v43.0_
_Filter group: Small_
### CloseCapabilityInput
Set a feed element to closed.
Users can’t edit (specifically the feed item body or title), comment on, or delete a closed feed element. If the closed feed element is a poll, users can’t vote on it. Users can’t edit (specifically the comment body) or delete a comment on a closed feed element or select or remove it as best answer.
Admins and moderators can edit and delete closed feed elements and comments on closed feed elements. Admins and moderators can select or remove the best answer status on comments on closed feed elements.
* `isClosed` (_boolean_)
Specifies whether to set the feed element to closed (`true`) or not (`false`).
You must specify `isClosed` in a query parameter or a request body.
_Available in: v43.0_
### CommentsCapability
If a feed element or comment has this capability, the context user can add a comment.
* `page` (_object_)
The comments information for this feed element or comment.
Threaded comments are supported in version 44.0 and later.
_Available in: v32.0_
_Filter group: Small_
See the [GET /chatter/feed-elements/{feedElementId}/capabilities/comments/items](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getCommentsCapabilityItems) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
### CommentPage
A page of comments.
* `comments` (_array of object_)
Collection of comments.
**Important**: Use the `items` property as of version 32.0.
_Available in: v23.0–31.0_
_Filter group: Small_
See the [GET /chatter/comments/{commentId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/getComment) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
Each item: See the [GET /chatter/comments/{commentId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/getComment) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `currentPageToken` (_string_)
Token identifying the current page.
_Available in: v37.0_
_Filter group: Medium_
* `currentPageUrl` (_string_)
URL to the current page of comments, that is, the most recent comments. The default is 25 comments per page.
_Available in: v23.0_
_Filter group: Medium_
* `items` (_array of object_)
Collection of comments.
_Available in: v32.0_
_Filter group: Small_
See the [GET /chatter/comments/{commentId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/getComment) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
Each item: See the [GET /chatter/comments/{commentId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/getComment) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `nextPageToken` (_string_)
Token identifying the next page, or `null` if there isn’t a next page.
_Available in: v37.0_
_Filter group: Small_
* `nextPageUrl` (_string_)
URL to the next page of comments, that is, older comments. The default is 25 comments per page.
If you want to read more of the comments in search results, all the comments in the thread are refreshed, not just the ones that match the search term. Avoid using `nextPageUrl` until the comments are refreshed.
_Available in: v23.0_
_Filter group: Small_
* `previousPageToken` (_string_)
Token identifying the previous page, or `null` if there isn’t a previous page.
_Available in: v44.0_
_Filter group: Small_
* `previousPageUrl` (_string_)
Connect REST API URL identifying the previous page, or `null` if there isn’t a previous page.
_Available in: v44.0_
_Filter group: Small_
* `total` (_integer_)
Total number of published comments across all pages for the parent feed item.
_Available in: v23.0_
_Filter group: Small_
### MessageBodyInput
Message body input.
* `messageSegments` (_array of MessageSegmentInput_)
Collection of message segments, based on type. Segments can be one of the following:
* Message Segment Input: Entity Link (version 43.0 and later)
* Message Segment Input: Hash Tag
* Message Segment Input: Inline Image (version 35.0 and later)
* Message Segment Input: Link
* Message Segment Input: Markup Begin (version 35.0 and later)
* Message Segment Input: Markup End (version 35.0 and later)
* Message Segment Input: Mention
* Message Segment Input: Text
_Available in: v23.0_
### DirectMessageCapability
If a feed element has this capability, it’s a direct message.
* `memberChanges` (_object_)
DirectMessageMembershipActivityCollection
Member activities of the direct message, with the most recent activity first.
_Available in: v40.0_
_Filter group: Big_
Includes all fields of `DirectMessageMembershipActivityCollection`.
* `members` (_object_)
DirectMessageMemberCollection
Members included in the direct message.
_Available in: v39.0_
_Filter group: Small_
Includes all fields of `DirectMessageMemberCollection`.
* `originalMembers` (_object_)
DirectMessageMemberCollection
Original members of the direct message.
_Available in: v40.0_
_Filter group: Big_
Includes all fields of `DirectMessageMemberCollection`.
* `subject` (_string_)
Subject of the direct message.
_Available in: v39.0_
_Filter group: Small_
### DirectMessageCapabilityInput
Create or update the members of a direct message.
* `membersToAdd` (_array of string_)
List of user IDs for members to include in the direct message.
Required when creating a direct message (POST). Optional when updating a direct message (PATCH)
_Available in: v39.0_
* `membersToRemove` (_array of string_)
List of user IDs for members to remove from the direct message.
Optional when updating a direct message (PATCH). Not supported when creating a direct message (POST)
_Available in: v40.0_
* `subject` (_string_)
Subject of the direct message.
Optional when creating a direct message (POST). Not supported when updating a direct message (PATCH)
_Available in: v39.0_
### DirectMessageMemberCollection
A collection of direct message members.
* `currentPageToken` (_string_)
Page token to access the current page of direct message members.
_Available in: v39.0_
_Filter group: Small_
* `currentPageUrl` (_string (url)_)
URL to the current page of direct message members.
_Available in: v39.0_
_Filter group: Small_
* `nextPageToken` (_string_)
Page token to access the next page of direct message members.
_Available in: v39.0_
_Filter group: Small_
* `nextPageUrl` (_string (url)_)
URL to the next page of direct message members.
_Available in: v39.0_
_Filter group: Small_
* `users` (_array of UserSummary_)
Collection of direct message members.
_Available in: v39.0_
_Filter group: Small_
### DirectMessageMembershipActivityCollection
A collection of direct message member activities.
* `activities` (_array of DirectMessageMembershipActivity_)
Collection of direct message member activities.
_Available in: v40.0_
_Filter group: Small_
* `currentPageToken` (_string_)
Token identifying the current page.
_Available in: v40.0_
_Filter group: Medium_
* `currentPageUrl` (_string (url)_)
Connect REST API URL identifying the current page.
_Available in: v40.0_
_Filter group: Medium_
* `nextPageToken` (_string_)
Token identifying the next page, or `null` if there isn’t a next page.
_Available in: v40.0_
_Filter group: Small_
* `nextPageUrl` (_string (url)_)
Connect REST API URL identifying the next page, or `null` if there isn’t a next page.
_Available in: v40.0_
_Filter group: Small_
### MuteCapability
If a feed element has this capability, users can mute it. Muted feed elements are visible in the muted feed, and invisible in all other feeds that respect mute.
* `isMutedByMe` (_boolean_)
Indicates whether the context user muted the feed element.
_Available in: v35.0_
_Filter group: Small_
### MuteCapabilityInput
Mute or unmute a feed element.
* `isMutedByMe` (_boolean_)
Indicates whether the feed element is muted for the context user. Default value is `false`.
_Available in: v35.0_
### PollCapability
If a feed element has this capability, the feed element can include a poll for voting.
* `choices` (_array of FeedPollChoice_)
Collection of poll choices that make up the poll.
_Available in: v32.0_
_Filter group: Small_
* `myChoiceId` (_string (Id)_)
18-character ID of the poll choice that the context user has voted for in this poll. Returns `null` if the context user has not voted.
_Available in: v32.0_
_Filter group: Small_
* `totalVoteCount` (_string_)
Total number of votes cast on the feed poll element.
_Available in: v32.0_
_Filter group: Small_
### PollCapabilityInput
Create or vote on a poll feed element.
To create a poll, use the Feed Elements, Post and Search resource.
To vote on a poll, use the Feed Elements Capability, Poll resource.
#### XML example for creating a poll
```
Monday
Tuesday
```
* `choices` (_array of string_)
The choices used to create a new poll. You must specify 2–10 poll choices for each poll.
Required for creating a poll
_Available in: v32.0_
* `myChoiceId` (_string_, required)
ID of an existing choice on the feed poll. Used to vote on an existing poll.
Required for voting on a poll
_Available in: v32.0_
### QuestionAndAnswersCapability
If a feed element has this capability, it has a question and comments on the feed element are answers to the question.
* `bestAnswer` (_object_)
Comment selected as the best answer for the question.
_Available in: v32.0_
_Filter group: Small_
See the [GET /chatter/comments/{commentId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Comments-Resources/operation/getComment) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `bestAnswerSelectedBy` (_object_)
UserSummary
User who selected the best answer for the question.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
* `canCurrentUserSelectOrRemoveBestAnswer` (_boolean_)
Indicates whether the context user can select or remove a best answer (`true`) or not (`false`).
_Available in: v32.0_
_Filter group: Small_
* `candidateAnswers` (_object_)
CandidateAnswersStatus
Status of candidate answers for the question.
_Available in: v41.0_
_Filter group: Small_
Includes all fields of `CandidateAnswersStatus`.
* `escalatedCase` (_object_)
Reference
If a question post is escalated, this is the case to which it was escalated.
_Available in: v33.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `questionTitle` (_string_)
Title for the question.
_Available in: v32.0_
_Filter group: Small_
### QuestionAndAnswersCapabilityInput
Create or edit a question feed element or set the best answer of the existing question feed element.
* `bestAnswerId` (_string_)
A comment ID to use as a best answer for a question feed element. The best answer comment must already exist on the question feed element.
Required to PATCH the best answer. Not supported in POST requests.
_Available in: v32.0_
* `questionTitle` (_string_)
Title for a question feed element.
To edit the title of a question, make a PATCH request to `/chatter/feed-elements/{feedElementId}`. Editing question titles is supported in version 34.0 and later.
Required to POST or PATCH a question.
_Available in: v32.0_
### ReadByCapability
If a feed element has this capability, the context user can mark it as read.
* `isReadByMe` (_boolean_)
Specifies whether the feed element has been read (`true`) or not (`false`) by the context user.
_Available in: v40.0_
_Filter group: Small_
* `lastReadDateByMe` (_string (date-time)_)
Last date when the feed element was marked read for the context user in ISO 8601 format. Otherwise, `null`.
_Available in: v40.0_
_Filter group: Small_
* `page` (_object_)
ReadByCollection
First page of information about who read the feed element and when.
_Available in: v40.0_
_Filter group: Big_
Includes all fields of `ReadByCollection`.
### ReadByCollection
A collection of information about who read the feed element and when.
* `currentPageToken` (_string_)
Token identifying the current page.
_Available in: v40.0_
_Filter group: Medium_
* `currentPageUrl` (_string (url)_)
Connect REST API URL identifying the current page. The default is 25 items per page.
_Available in: v40.0_
_Filter group: Medium_
* `items` (_array of ReadBy_)
Collection of read-by information, including users and when they last read the feed element.
_Available in: v40.0_
_Filter group: Big_
* `nextPageToken` (_string_)
Token identifying the next page, or `null` if there isn’t a next page.
_Available in: v40.0_
_Filter group: Small_
* `nextPageUrl` (_string (url)_)
Connect REST API URL identifying the next page, or `null` if there isn’t a next page.
_Available in: v40.0_
_Filter group: Small_
* `previousPageToken` (_string_)
Reserved for future use.
_Available in: v40.0_
_Filter group: Medium_
* `previousPageUrl` (_string (url)_)
Reserved for future use.
_Available in: v40.0_
_Filter group: Medium_
* `total` (_integer_)
Total number of users who read the feed element.
This count appears in the UI under feed posts in private and unlisted Chatter groups as the “seen by” number, for example, “Seen by 48.”
_Available in: v40.0_
_Filter group: Small_
### ApprovalCapability
If a feed element has this capability, it includes information about an approval.
* `id` (_string (Id)_)
The work item ID. The work item ID is `null` if there isn’t a pending work item associated with the approval record.
_Available in: v32.0_
_Filter group: Small_
* `postTemplateFields` (_array of ApprovalPostTemplateField_)
The details of the approval post template field.
_Available in: v32.0_
_Filter group: Small_
* `processInstanceStepId` (_string (Id)_)
The process instance step ID. The associated record represents one step in an approval process.
_Available in: v32.0_
_Filter group: Small_
* `status` (_object_)
ConnectWorkflowProcessStatusEnum
The status of the approval.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `ConnectWorkflowProcessStatusEnum`.
### AssociatedActionsCapability
If a feed element has this capability, it has platform actions associated with it.
* `platformActionGroups` (_array of PlatformActionGroup_)
The platform action groups associated with a feed element. Platform action groups are returned in the order specified in the Associated Actions Capability Input request body.
_Available in: v33.0_
_Filter group: Medium_
### BannerCapability
If this feed element has this capability, it has a banner motif and style.
* `motif` (_object_)
Motif
A banner motif.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `Motif`.
* `style` (_object_)
ConnectBannerStyleEnum
Decorates a feed item with a color and set of icons.
* `Announcement` — An announcement displays in a designated location in the Salesforce UI until 11:59 p.m. on its expiration date, unless it’s deleted or replaced by another announcement.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `ConnectBannerStyleEnum`.
### CallCollaborationCapability
If a feed element has this capability, it has a recording comment.
* `commentEndTime` (_integer_)
End time of the comment on the media player, in seconds.
_Available in: v51.0_
_Filter group: Small_
* `commentStartTime` (_integer_)
Start time of the comment on the media player, in seconds.
_Available in: v51.0_
_Filter group: Small_
### CanvasCapability
If a feed element has this capability, it renders a canvas app.
* `description` (_string_)
A description of the canvas app. The maximum size is 255 characters.
_Available in: v32.0_
_Filter group: Small_
* `developerName` (_string_)
The API name (developer name) of the client app.
_Available in: v32.0_
_Filter group: Small_
* `height` (_string_)
The height of the canvas app in pixels.
_Available in: v32.0_
_Filter group: Small_
* `icon` (_object_)
Icon
The icon for the canvas app.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `Icon`.
* `namespacePrefix` (_string_)
A unique namespace prefix for the canvas app.
_Available in: v32.0_
_Filter group: Small_
* `parameters` (_string_)
JSON parameters passed to the canvas app.
_Available in: v32.0_
_Filter group: Small_
* `thumbnailUrl` (_string (url)_)
A thumbnail URL to a preview image. The maximum thumbnail size is 120 pixels by 120 pixels.
_Available in: v32.0_
_Filter group: Small_
* `title` (_string_)
A title for the canvas link.
_Available in: v32.0_
_Filter group: Small_
### CaseCommentCapability
If a feed element has this capability, it has a case comment on the case feed.
* `actorType` (_object_)
ConnectCaseActorTypeEnum
Specifies the type of user who made the comment.
* `Customer` — if a Chatter customer made the comment
* `CustomerService` — if a service representative made the comment
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `ConnectCaseActorTypeEnum`.
* `createdBy` (_object_)
UserDetail
Information about the user who created the comment.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `UserDetail`.
* `createdDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z.
_Available in: v32.0_
_Filter group: Small_
* `eventType` (_object_)
ConnectCaseCommentEventTypeEnum
Specifies an event type for a comment in the case feed.
* `NewInternal` — A case comment that has newly been marked Internal Only.
* `NewPublished` — A newly published case comment.
* `NewPublishedByCustomer` — A case comment by a customer that was newly published.
* `PublishExisting` — An existing case comment that was republished.
* `PublishExistingByCustomer` — An existing case comment by a customer that was republished.
* `UnpublishExistingByCustomer` — An existing case comment by a customer that was unpublished.
* `UnpublishExsiting` — An existing case comment that was unpublished. Unfortunately, this typo is in the code, not the documentation. Use this spelling in your code.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `ConnectCaseCommentEventTypeEnum`.
* `id` (_string (Id)_)
18-character ID of case comment.
_Available in: v32.0_
_Filter group: Small_
* `published` (_boolean_)
Specifies whether the comment has been published.
_Available in: v32.0_
_Filter group: Small_
* `text` (_string_)
Text of the case comment.
_Available in: v32.0_
_Filter group: Small_
### ContentCapability
If a comment has this capability, it has a file attachment.
For files attached to a feed post (instead of a comment) in version 36.0 and later, use Files Capability.
If content is deleted from a feed element after it’s posted or if the access to the content is changed to private, the Content Capability exists, however most of its properties are null.
* `checksum` (_string_)
MD5 checksum for the file.
_Available in: v32.0_
_Filter group: Small_
* `contentHubRepository` (_object_)
FilesConnectRepository
The external data source associated with this file, or `null` if it doesn’t point to an external file.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `FilesConnectRepository`.
* `contentUrl` (_string (url)_)
URL of the content for links and Google docs.
_Available in: v32.0_
_Filter group: Small_
* `description` (_string_)
Description of the attachment.
_Available in: v32.0_
_Filter group: Small_
* `downloadUrl` (_string (url)_)
URL to the content.
_Available in: v32.0_
_Filter group: Small_
* `externalDocumentUrl` (_string (url)_)
The external URL this file points to, or `null` if it does not point to an external file.
_Available in: v32.0_
_Filter group: Small_
* `fileExtension` (_string_)
Extension of the file.
_Available in: v32.0_
_Filter group: Small_
* `fileSize` (_string_)
Size of the file in bytes. If size cannot be determined, returns `Unknown`.
_Available in: v32.0_
_Filter group: Small_
* `fileType` (_string_)
Type of file.
_Available in: v32.0_
_Filter group: Small_
* `hasPdfPreview` (_boolean_)
`true` if the file has a PDF preview available, `false` otherwise.
_Available in: v32.0_
_Filter group: Medium_
* `id` (_string (Id)_)
18-character ID of the content.
_Available in: v32.0_
_Filter group: Small_
* `isInMyFileSync` (_boolean_)
`true` if the file is synced with Salesforce Files Sync; `false` otherwise.
Salesforce Files Sync was retired on May 25, 2018.
_Available in: v32.0_
_Filter group: Small_
* `mimeType` (_string_)
MIME type of the file.
_Available in: v32.0_
_Filter group: Small_
* `renditionUrl` (_string (url)_)
URL to the rendition resource for the file. Renditions are processed asynchronously and may not be available immediately after the file has been uploaded.
_Available in: v32.0_
_Filter group: Small_
* `renditionUrl240By180` (_string (url)_)
URL to the 240x180 size rendition resource for the file. Renditions are processed asynchronously and may not be available immediately after the file has been uploaded.
_Available in: v32.0_
_Filter group: Small_
* `renditionUrl720By480` (_string (url)_)
URL to the 720x480 size rendition resource for the file. Renditions are processed asynchronously and may not be available immediately after the file has been uploaded.
_Available in: v32.0_
_Filter group: Small_
* `repositoryFileId` (_string_)
ID of the file in the external repository, or `null` if the file isn’t external.
_Available in: v36.0_
_Filter group: Small_
* `repositoryFileUrl` (_string (url)_)
The URL of the Connect REST API resource giving access to the external repository file properties, or `null` if this file doesn’t point to an external file.
_Available in: v32.0_
_Filter group: Small_
* `sharingOption` (_object_)
ConnectFileSharingOptionEnum
Sharing option of the file. Values are:
* `Allowed` — Resharing of the file is allowed.
* `Restricted` — Resharing of the file is restricted.
_Available in: v35.0_
_Filter group: Medium_
Includes all fields of `ConnectFileSharingOptionEnum`.
* `textPreview` (_string_)
Text preview of the file if available, `null` otherwise. The maximum number of characters is 200.
_Available in: v32.0_
_Filter group: Big_
* `thumb120By90RenditionStatus` (_string_)
The status of the rendering of the 120x90 pixel sized preview image of the file. Should be either Processing, Failed, Success, or Na if unavailable.
_Available in: v32.0_
_Filter group: Medium_
* `thumb240By180RenditionStatus` (_string_)
The status of the rendering of the 240x180 pixel sized preview image of the file. Should be either Processing, Failed, Success, or Na if unavailable.
_Available in: v32.0_
_Filter group: Medium_
* `thumb720By480RenditionStatus` (_string_)
The status of the rendering of the 720x480 pixel sized preview image of the file. Should be either Processing, Failed, Success, or Na if unavailable.
_Available in: v32.0_
_Filter group: Medium_
* `title` (_string_)
Title of the file.
_Available in: v32.0_
_Filter group: Small_
* `versionId` (_string (Id)_)
Version ID of the file.
_Available in: v32.0_
_Filter group: Medium_
### DashboardComponentSnapshotCapability
If a feed element has this capability, it has a dashboard component snapshot. A snapshot is a static image of a dashboard component at a specific point in time.
* `dashboardComponentSnapshot` (_object_)
DashboardComponentSnapshot
The dashboard component snapshot.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `DashboardComponentSnapshot`.
### EmailMessageCapability
If a feed element has this capability, it has an email message from a case.
* `attachments` (_array of EmailAttachment_)
Attachments in the email message.
_Available in: v36.0_
_Filter group: Big_
* `automationType` (_object_)
ConnectEmailMessageAutomationTypeEnum
Automation type of the email message. Values are:
* `aiAssisted` — The email message was created with the assistance of AI.
* `aiAutomated` — The email message was created automatically by AI.
_Available in: v63.0_
_Filter group: Small_
Includes all fields of `ConnectEmailMessageAutomationTypeEnum`.
* `bccAddresses` (_array of EmailAddress_)
BCC addresses for the email message.
_Available in: v36.0_
_Filter group: Small_
* `body` (_string_)
Body of the email message.
_Available in: v36.0_
_Filter group: Big_
* `ccAddresses` (_array of EmailAddress_)
CC addresses for the email message.
_Available in: v36.0_
_Filter group: Small_
* `direction` (_object_)
ConnectEmailMessageDirectionEnum
Direction of the email message. Values are:
* `Inbound` — An inbound message (sent by a customer).
* `Outbound` — An outbound message (sent to a customer by a support agent).
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `ConnectEmailMessageDirectionEnum`.
* `emailMessageId` (_string_)
ID of the email message.
_Available in: v32.0_
_Filter group: Small_
* `emailMessageSize` (_string_)
Size of a case’s email message HTML body.
* `Large` — `UseLargeHtmlBody` permission is set, HTML body exceeds 131K characters, and HTML email display is enabled.
* `Normal` — Email message doesn’t meet the `Large` criteria.
_Available in: v66.0_
_Filter group: Small_
* `emailSize` (_object_)
ConnectEmailMessageSizeEnum
Size of a case’s email message HTML body. Values are:
* `Large` — `UseLargeHtmlBody` permission is set, HTML body exceeds 131K characters, and HTML email display is enabled.
* `Normal` — Email message doesn’t meet the `Large` criteria.
_Available in: v66.0_
_Filter group: Small_
Includes all fields of `ConnectEmailMessageSizeEnum`.
* `fromAddress` (_object_)
EmailAddress
From address for the email message.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `EmailAddress`.
* `htmlExpandEmailThread` (_integer_)
Start location of previous email thread.
_Available in: v47.0_
_Filter group: Small_
* `isRichText` (_boolean_)
Indicates whether the body of the email message is in rich text format.
_Available in: v36.0_
_Filter group: Small_
* `status` (_object_)
ConnectEmailMessageStatusEnum
Status of an email message on a case.
_Available in: v47.0_
_Filter group: Small_
Includes all fields of `ConnectEmailMessageStatusEnum`.
* `subject` (_string_)
Subject of the email message.
_Available in: v32.0_
_Filter group: Small_
* `textBody` (_string_)
Body of the email message.
**Important**: In version 36.0 and later, use the `body` property.
_Available in: v32.0–35.0_
_Filter group: Big_
* `toAddresses` (_array of EmailAddress_)
To addresses of the email message.
_Available in: v32.0_
_Filter group: Small_
* `totalAttachments` (_integer_)
Total number of attachments in the email message.
_Available in: v38.0_
_Filter group: Small_
### EnhancedLinkCapability
If a feed element has this capability, it has a link that may contain supplemental information like an icon, a title, and a description.
* `description` (_string_)
A description with a 500 character limit.
_Available in: v32.0_
_Filter group: Small_
* `icon` (_object_)
Icon
An icon.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `Icon`.
* `linkRecordId` (_string (Id)_)
An ID associated with the link if the link URL refers to a Salesforce record.
_Available in: v32.0_
_Filter group: Small_
* `linkUrl` (_string (url)_)
A link URL to a detail page if available content can’t display inline.
_Available in: v32.0_
_Filter group: Small_
* `title` (_string_)
A title to a detail page.
_Available in: v32.0_
_Filter group: Small_
### ExtensionsCapability
If a feed element has this capability, it has one or more extensions associated with it.
* `items` (_array of Extension_)
Collection of extensions.
_Available in: v40.0_
_Filter group: Small_
### FeedEntityShareCapability
If a feed element or comment has this capability, a feed entity is shared with it.
* `feedEntity` (_FeedItemSummary | FeedEntityNotAvailableSummary_)
The summary of the feed entity that is shared with the feed element or comment. One of these response bodies:
* Feed Item Summary
* Feed Entity Not Available Summary
_Available in: v39.0_
_Filter group: Small_
One of: `FeedItemSummary`, `FeedEntityNotAvailableSummary`.
### MultipleContentCapability
If a feed element has this capability, it has one or more file attachments.
* `items` (_array of Content_)
Collection of files.
_Available in: v36.0_
_Filter group: Small_
### InteractionsCapability
If a feed element has this capability, it has information about user interactions.
* `count` (_integer (int64)_)
The number of individual views, likes, and comments on a feed post.
This count appears in the UI under the feed post as the number of views, for example, “5 views.”
_Available in: v37.0_
_Filter group: Small_
### LinkCapability
If a feed element has this capability, it has a link.
* `url` (_string (url)_)
Link URL. The URL can be to an external site.
_Available in: v32.0_
_Filter group: Small_
* `urlName` (_string_)
Description of the link.
_Available in: v32.0_
_Filter group: Small_
### MediaReferenceCapability
If a feed element has this capability, it has one or more media references.
* `media` (_array of MediaReference_)
Collection of media references.
_Available in: v41.0_
_Filter group: Small_
### OriginCapability
If a feed element has this capability, it was created by a feed action.
* `actor` (_object_)
UserSummary
The user who executed the feed action.
_Available in: v33.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
* `originRecord` (_object_)
Reference
A reference to the feed element containing the feed action.
_Available in: v33.0_
_Filter group: Small_
Includes all fields of `ReferenceCore`.
### RecommendationsCapability
If a feed element has this capability, it has a recommendation.
* `items` (_array of EntityRecommendation_)
A collection of recommendations.
_Available in: v32.0_
_Filter group: Small_
### RecordSnapshotCapability
If a feed element has this capability, it contains all the snapshotted fields of a record for a single create record event.
* `recordView` (_object_)
RecordView
A record representation that includes metadata and data so you can display the record easily.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `RecordView`.
### SocialPostCapability
If a feed element has this capability, it can interact with a social post on a social network.
* `author` (_object_)
SocialAccount
Social account that authored the social post.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `SocialAccount`.
* `content` (_string_)
Content body of the social post.
_Available in: v36.0_
_Filter group: Medium_
* `deletedBy` (_object_)
UserSummary
User who deleted the social post.
_Available in: v38.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
* `hiddenBy` (_object_)
UserSummary
User who hid the social post.
_Available in: v41.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
* `icon` (_object_)
Icon
Icon of the social network.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `Icon`.
* `id` (_string_)
ID associated with the social post Salesforce record.
_Available in: v36.0_
_Filter group: Small_
* `isOutbound` (_boolean_)
If `true`, the social post originated from the Salesforce application.
_Available in: v36.0_
_Filter group: Small_
* `likedBy` (_string_)
External social account who liked the social post.
_Available in: v40.0_
_Filter group: Small_
* `messageType` (_object_)
ConnectSocialPostMessageTypeEnum
Message type of the social post.
_Available in: v38.0_
_Filter group: Small_
Includes all fields of `ConnectSocialPostMessageTypeEnum`.
* `name` (_string_)
Title or heading of the social post.
_Available in: v36.0_
_Filter group: Small_
* `postUrl` (_string (url)_)
External URL to the social post on the social network.
_Available in: v36.0_
_Filter group: Small_
* `provider` (_object_)
ConnectSocialNetworkProviderEnum
Social network that this social post belongs to.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `ConnectSocialNetworkProviderEnum`.
* `recipient` (_object_)
SocialAccount
Social account that is the recipient of the social post.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `SocialAccount`.
* `recipientId` (_string_)
ID of the recipient of the social post.
_Available in: v38.0_
_Filter group: Small_
* `reviewScale` (_number (double)_)
Review scale of the social post.
_Available in: v40.0_
_Filter group: Small_
* `reviewScore` (_number (double)_)
Review score of the social post.
_Available in: v40.0_
_Filter group: Small_
* `status` (_object_)
SocialPostStatus
Status of the social post.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `SocialPostStatus`.
### TrackedChangesCapability
If a feed element has this capability, it contains all changes to a record for a single tracked change event.
* `changes` (_array of FeedTrackedChange_)
Collection of feed tracked changes.
_Available in: v32.0_
_Filter group: Small_
### ConnectRelatedFeedPostTypeEnum
What type of related posts: Generic is the default value.
Type: `string`.
Allowed values: `Answered`, `BestAnswer`, `Generic`, `Unanswered`.
### AbstractRelatedFeedPostCollection
A collection of related feed posts.
* `relatedFeedPosts` (_array of AbstractRelatedFeedPost_)
Collection of related feed posts.
_Available in: v37.0_
_Filter group: Small_
### FeedDirectory
Feed directory.
* `favorites` (_array of Favorite_)
Collection of favorites that the context user has saved.
_Available in: v24.0_
_Filter group: Small_
* `feeds` (_array of FeedDirectoryItem_)
Collection of feed directory items that the context user is allowed to view
_Available in: v23.0_
_Filter group: Small_
### FavoritesPage
Page of Chatter favorites.
* `favorites` (_array of Favorite_)
Collection of one or more favorites
_Available in: v24.0_
_Filter group: Small_
* `total` (_integer_)
Total number of favorites
_Available in: v24.0_
_Filter group: Small_
### FeedFavoriteInput
Description of a feed favorite input.
* `searchText` (_string_) Text of the feed search. Use this parameter for feed searches only.
* `targetId` (_string_) Id of the topic. Use this parameter for topics only.
* `updateLastViewDate` (_boolean_)
Sets the last view date of the specified feed favorite to the current system time. Default value is `false`.
Required for updating a favorite. Don't specify when creating a favorite.
### Favorite
Chatter favorite.
* `community` (_object_)
ReferenceCore
Information about the Experience Cloud site. Returns `null` if the favorite exists in the default community or digital experiences isn’t enabled.
_Available in: v26.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `createdBy` (_object_)
UserSummary
Information about the original creator of the favorite.
_Available in: v24.0_
_Filter group: Medium_
Includes all fields of `UserSummary`.
* `feedUrl` (_string_)
URL to the feed item for the favorite.
_Available in: v24.0_
_Filter group: Small_
* `id` (_string_)
18-character ID of the favorite.
_Available in: v24.0_
_Filter group: Small_
* `lastViewDate` (_string_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z
_Available in: v24.0_
_Filter group: Medium_
* `name` (_string_)
Name of the favorite.
_Available in: v24.0_
_Filter group: Small_
* `searchText` (_string_)
If the favorite is from a search, contains the search text, if not, contains `null`.
_Available in: v24.0_
_Filter group: Medium_
* `target` (_object_)
ReferenceCore
A reference to the topic if applicable, `null` otherwise.
_Available in: v28.0_
_Filter group: Small_
Includes all fields of `ReferenceCore`.
* `type` (_string_)
One of the following values:
* `ListView`
* `Search`
* `Topic`
_Available in: v24.0_
_Filter group: Small_
* `url` (_string_)
URL to the favorite.
_Available in: v24.0_
_Filter group: Small_
* `user` (_object_)
UserSummary
Information about the user who saved the favorite.
_Available in: v24.0_
_Filter group: Medium_
Includes all fields of `UserSummary`.
### ConnectFeedDensityEnum
How much of the feed to return in a request for a feed item page.
Type: `string`.
Allowed values: `AllUpdates`, `FewerUpdates`.
### ConnectNetworkModerationVisibilityEnum
Visibility behavior of a flag for various user types. Values are:
* `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item.
* `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
_Available in: v40.0_
_Filter group: Small_
Type: `string`.
Allowed values: `ModeratorsOnly`, `SelfAndModerators`.
### ModerationFlags
Moderation flags.
* `flagCount` (_integer_)
If the context user is a community moderator, the total number of flags on the post, comment, or file. If the context user isn’t a community moderator, value is `null`.
Flags on files is available starting in version 30.0.
_Available in: v29.0_
_Filter group: Small_
* `flagCountByReason` (_object_)
Number of moderation flags categorized by reason. Values for String are:
* `FlaggedByRule` — Moderation rule flagged the item.
* `FlaggedBySystem` — Einstein flagged the item.
* `FlaggedByUserAsInappropriate` — User flagged the item as inappropriate.
* `FlaggedByUserAsSpam` — User flagged the item as spam.
_Available in: v40.0_
_Filter group: Small_
Additional properties: `integer`.
* `flaggedByMe` (_boolean_)
Indicates whether the post, comment, or file was flagged by the context user ( `true` ) or not ( `false` ).
Flags on files is available starting in version 30.0.
_Available in: v29.0_
_Filter group: Small_
* `flags` (_object_)
ModerationFlagsCollection
Collection of flags.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `ModerationFlagsCollection`.
### ConnectNetworkModerationTypeEnum
Type of moderation flag. Values are:
* `FlagAsInappropriate` — Flag for inappropriate content.
* `FlagAsSpam` — Flag for spam.
_Available in: v40.0_
_Filter group: Small_
Type: `string`.
Allowed values: `FlagAsInappropriate`, `FlagAsSpam`.
### ModerationFlagInput
Moderation flag input.
* `note` (_string_)
A note of up to 4,000 characters about the flag.
_Available in: v38.0_
* `type` (_object_)
ConnectNetworkModerationTypeEnum
Type of moderation flag.
* `FlagAsInappropriate` — Flag for inappropriate content.
* `FlagAsSpam` — Flag for spam.
_Available in: v38.0_
Includes all fields of `ConnectNetworkModerationTypeEnum`.
* `visibility` (_object_)
ConnectNetworkModerationVisibilityEnum
Visibility behavior of a flag for various user types.
* `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item.
* `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
_Available in: v30.0_
Includes all fields of `ConnectNetworkModerationVisibilityEnum`.
### ModerationCapability
If a feed element has this capability, users in the Experience Cloud site can flag the feed element for moderation. This response body also includes information about the flagged content.
* `moderationFlags` (_object_)
ModerationFlags
Flags for this feed element. Moderators can view and take action on flagged items.
_Available in: v31.0_
_Filter group: Big_
Includes all fields of `ModerationFlags`.
### Feed
Chatter feed.
* `feedElementPostUrl` (_string (url)_)
URL to post feed elements to this subject.
When returned by a request that includes the HTTP header `X-Connect-Bearer-Urls: true`, the URL includes a bearer token. Use this bearer token URL to make POST requests.
_Available in: v31.0_
_Filter group: Small_
* `feedElements` (_object_)
Page of feed elements for the feed specified in `redirectedFeedType`. Otherwise, `null`.
_Available in: v40.0_
_Filter group: Small_
See the [GET /chatter/feed-elements](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCollection) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `feedElementsUrl` (_string (url)_)
URL to feed elements.
_Available in: v31.0_
_Filter group: Small_
* `isModifiedUrl` (_string (url)_)
A News Feed Is-Modified resource with a `{since}` request parameter that contains an opaque token that describes when the feed was last modified. Returns `null` if feed is not a news feed.
This feature is available through a Feed Polling pilot program. This pilot program is closed and not accepting new participants.
_Available in: v23.0_
_Filter group: Small_
* `pinnedFeedElementsUrl` (_string (url)_)
URL to pinned feed items.
_Available in: v41.0_
_Filter group: Small_
* `redirectedFeedFilter` (_object_)
ConnectFeedFilter
Filter for the feed specified in `redirectedFeedType`. Otherwise, `null`.
_Available in: v42.0_
_Filter group: Small_
Includes all fields of `ConnectFeedFilter`.
* `redirectedFeedSort` (_object_)
ConnectFeedSortOrder
Sort order for the feed specified in `redirectedFeedType`. Otherwise, `null`.
_Available in: v42.0_
_Filter group: Small_
Includes all fields of `ConnectFeedSortOrder`.
* `redirectedFeedType` (_object_)
ConnectFeedType
Specifies which feed is returned if `pageSize` is specified. Otherwise, `null`.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `ConnectFeedType`.
* `respectsMute` (_boolean_)
Indicates whether the feed respects the mute feature. If `true`, the feed shows the ability to mute or unmute each element, depending on the value of `isMutedByMe`; `null` if the mute feature is disabled for the organization.
_Available in: v35.0_
_Filter group: Small_
* `feedItemsUrl` (_string_)
URL to feed items.
_Available in: v23.0–31.0_
_Filter group: Small_
### FeedModifiedInfo
Feed modified information.
This feature is available through a Feed Polling pilot program. This pilot program is closed and not accepting new participants.
* `isModified` (_boolean_)
`true` if a news feed and has been modified since the last time it was polled, `false` otherwise. Returns `null` if the feed is not a news feed.
_Available in: v23.0_
_Filter group: Small_
* `isModifiedToken` (_string_)
An opaque polling token that describes when a news feed was last modified. Use this value as the `{since}` request parameter of the News Feed Is-Modified resource.
_Available in: v27.0_
_Filter group: Small_
* `nextPollUrl` (_string (url)_)
A News Feed Is-Modified resource with a `{since}` request parameter that contains an opaque token that describes when the feed was last modified. Returns `null` if feed is not a news feed. Make a request to this resource after making a request to the `isModifiedUrl` resource in the Feed or Feed Item Page response bodies.
_Available in: v23.0_
_Filter group: Small_
### PinnedFeedElementCollection
Collection of pinned feed elements.
* `elements` (_array of object_)
Collection of pinned feed elements.
**Note**: In the UI, pinned feed elements don’t show all auxiliary information, such as comments, likes, interaction counts, or read by information. As a result, the Pinned Feed Element Collection doesn’t include all the information for these capabilities.
_Available in: v41.0_
_Filter group: Small_
See the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
Each item: See the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
### PinCapabilityInput
Pin or unpin a feed element to a feed.
* `entityId` (_string_, required)
ID of the entity to pin or unpin. In version 41.0 and later, `entityId` must be a feed item ID. In version 41.0–42.0, only one feed item can be pinned per feed. In version 43.0 and later, three feed items can be pinned per feed.
_Available in: v41.0_
* `isPinned` (_boolean_, required)
Specifies whether to pin (`true`) or unpin (`false`) the entity.
_Available in: v41.0_
### PinCapability
If a feed element has this capability, users who have permission can pin it to a feed.
* `isPinnableByMe` (_boolean_)
Specifies whether the context user can pin or unpin the entity to the feed (`true`) or not (`false`).
_Available in: v41.0_
_Filter group: Small_
* `isPinned` (_boolean_)
Specifies whether the entity is pinned (`true`) or not pinned (`false`) to the feed.
_Available in: v41.0_
_Filter group: Small_
### TopicsCapabilitySbi
Existence of this capability on a Feed Element means the context user may add topics to that Feed Element. Topics are used to track trends in the organization.
Includes all fields of `AbstractFeedElementCapability`.
* `canAssignTopics` (_boolean_)
`true` if a topic can be assigned to the feed element, `false` otherwise.
_Available in: v32.0_
* `items` (_array of TopicSbi_)
A collection of topics associated with this feed element.
_Available in: v32.0_
### FeedItemTopicsInput
Description of a feedItem topic input.
* `topicId` (_string_)
ID of an existing topic
Required for existing topics if the `topicName` property isn’t used
_Available in: v29.0_
* `topicName` (_string_)
Name of a new or existing topic, up to 150 characters
Required for new topics; required for existing topics if the `topicId` property isn’t used
_Available in: v29.0_
### TopicSbi
Topic.
* `createdDate` (_string_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z
_Available in: v28.0_
_Filter group: Big_
* `description` (_string_)
Description of the topic
_Available in: v28.0_
_Filter group: Big_
* `id` (_string_)
18-character ID of the topic
_Available in: v28.0_
_Filter group: Small_
* `images` (_object_)
Images associated with the topic
_Available in: v32.0_
_Filter group: Medium_
Includes all fields of `TopicImagesSbi`.
* `isBeingDeleted` (_boolean_)
`true` if the topic is currently being deleted; `false` otherwise.
After the topic is deleted, when attempting to retrieve the topic, the response is [404: Not Found](/docs/platform/connect-rest-api/guide/connect_error_responses#status-codes-and-error-responses).
_Available in: v33.0_
_Filter group: Small_
* `name` (_string_)
Name of the topic
_Available in: v24.0_
_Filter group: Small_
* `nonLocalizedName` (_string_)
Non-localized name of the topic
_Available in: v36.0_
_Filter group: Medium_
* `talkingAbout` (_integer_)
Number of people talking about this topic over the last two months, based on factors such as topic additions and comments on posts with the topic
_Available in: v28.0_
_Filter group: Medium_
* `url` (_string_)
URL to the topic detail page
_Available in: v29.0_
_Filter group: Small_
### BatchResultItem
Batch result item.
* `result` (_string_)
Dependent on the type of batch. Value could be one of the following:
* Asset File for `/connect/file-assets/batch/{assetIds}` (v43.0)
* Audience for `/connect/communities/{communityId}/personalization/audiences/batch/{audienceIds}` (v48.0)
* Cart Item for `/commerce/webstores/{webstoreId}/carts/{cartId}/cart-items/batch` (v49.0) and `/commerce/webstores/{webstoreId}/carts/active/cart-items/batch` (v49.0)
* Comment for `/chatter/comments/batch/{commentIds}` (v42.0)
* Error Message (v23.0)
* Feed Item for `/chatter/feed-elements/batch` (v32.0) and `/chatter/feed-elements/batch/{feedElementIds}` (v32.0)
* File Summary for `/connect/files/batch/{fileIds}` (v26.0)
* Group for `/chatter/groups/batch/{groupIds}` (v23.0)
* Group Member for `/chatter/group-memberships/batch/{membershipIds}` (v27.0)
* Motif for `/connect/motifs/batch/{idOrPrefixList}` (v27.0)
* Read By Capability for `/chatter/feed-elements/batch/{feedElementIds}/capabilities/read-by` (v40.0)
* Target for `/connect/communities/{communityId}/personalization/targets/batch/{targetIds}` (v47.0)
* Topics People Are Knowledgeable About Collection for `/chatter/users/batch/{userIds}/knowledgeable-about-topics` (v36.0)
* User Detail for `/chatter/users/batch/{userIds}` (v23.0)
* For `/connect/batch`, the value can be any response body depending on the subrequest in the batch. (v28.0)
_Filter group: Small_
* `statusCode` (_integer_)
HTTP status code indicating the status of this individual request in the batch.
_Available in: v23.0_
_Filter group: Small_
### FeedItemBody
Chatter feed item body.
* `isRichText` (_boolean_)
Indicates if the body is rich text.
_Available in: v35.0_
_Filter group: Small_
* `messageSegments` (_array of MessageSegment_)
Collection of message segments, based on type. Segments can be one or more of the following:
* Message Segment: Entity Link
* Message Segment: Field Change
* Message Segment: Field Change Name
* Message Segment: Field Change Value
* Message Segment: Hashtag
* Message Segment: Inline Image (version 35.0 and later)
* Message Segment: Link
* Message Segment: Markup Begin (version 35.0 and later)
* Message Segment: Markup End (version 35.0 and later)
* Message Segment: Mention
* Message Segment: More Changes
* Message Segment: Text
The collection of message segments could contain message segment types introduced in later API versions. All message segment types are guaranteed to have text and type properties that are available in version 23.0 and later. If a client encounters an unknown message segment type, it can render the text value as a fallback.
_Available in: v23.0_
_Filter group: Medium_
* `text` (_string_)
Display-ready text of the message. Use this text if you don’t want to process the message segments.
_Available in: v23.0_
_Filter group: Small_
### CommentCapabilities
A container for all capabilities that can be included with a comment.
* `comments` (_object_)
CommentsCapability
If a comment has this capability, it has threaded comments.
_Available in: v44.0_
_Filter group: Small_
Includes all fields of `CommentsCapability`.
* `content` (_object_)
ContentCapability
Content, such as a file attachment, associated with this comment.
Most Content Capability properties are null if the content has been deleted from the feed element or if the access has changed to private.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `ContentCapability`.
* `edit` (_object_)
EditCapability
If a comment has this capability, users who have permission can edit it.
_Available in: v34.0_
_Filter group: Small_
Includes all fields of `EditCapability`.
* `feedEntityShare` (_object_)
If a comment has this capability, a feed entity is shared with it.
_Available in: v42.0_
_Filter group: Small_
See the [GET /chatter/feed-elements/{feedElementId}/capabilities/feed-entity-share](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedEntityShareCapability) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `record` (_object_)
RecordCapability
If a comment has this capability, it has a record attachment.
_Available in: v42.0_
_Filter group: Small_
Includes all fields of `RecordCapability`.
* `status` (_object_)
StatusCapability
If a comment has this capability, it has a status that determines its visibility.
_Available in: v38.0_
_Filter group: Small_
Includes all fields of `StatusCapability`.
* `upDownVote` (_object_)
UpDownVoteCapability
If a comment has this capability, users can upvote or downvote it.
_Available in: v41.0_
_Filter group: Small_
Includes all fields of `UpDownVoteCapability`.
* `verified` (_object_)
VerifiedCapability
If a comment has this capability, users with permission can mark it as verified or unverified.
_Available in: v41.0_
_Filter group: Small_
Includes all fields of `VerifiedCapability`.
### ClientInfo
Client information.
* `applicationName` (_string_)
Name of app used for authentication.
_Available in: v23.0_
_Filter group: Small_
* `applicationUrl` (_string (url)_)
URL to the app used for authentication
_Available in: v23.0_
_Filter group: Small_
### ReferenceCore
A reference to a record.
* `id` (_string_)
The ID of the record being referenced, which could be an 18-character ID or some other string identifier.
_Available in: v23.0_
_Filter group: Small_
* `url` (_string (url)_)
The URL to the resource endpoint.
_Available in: v23.0_
_Filter group: Small_
### LikeMessageBody
Chatter like message body.
* `messageSegments` (_array of MessageSegment_)
Collection of message segments, based on type. Segments can be one or more of the following:
* Message Segment: Entity Link
* Message Segment: Resource Link
* Message Segment: Text
_Available in: v27.0_
_Filter group: Medium_
* `text` (_string_)
Text summary of the users who like the feed item or comment. For example, “You like this.” or “Renee Moreau, Gordon Johnson, and Pam Jones like this.”
_Available in: v27.0_
_Filter group: Small_
### ConnectCommentTypeEnum
Indicates the type of comment. Valid values are:
* `ContentComment` — the comment contains an attachment
* `TextComment` — the comment contains only text
_Available in: v24.0_
_Filter group: Small_
Type: `string`.
Allowed values: `ContentComment`, `TextComment`.
### UserSummary
The User Summary response body is a subset of the User Detail response body.
* `additionalLabel` (_string_)
If one exists, an extra label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.”
_Available in: v30.0_
_Filter group: Small_
* `communityNickname` (_string_)
User’s nickname in the site.
_Available in: v32.0_
_Filter group: Medium_
* `companyName` (_string_)
Name of the company.
_Available in: v23.0_
_Filter group: Small_
* `displayName` (_string_)
User’s name that is displayed in the site. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed.
_Available in: v32.0_
_Filter group: Small_
* `firstName` (_string_)
User's first name. In version 39.0 and later, if nicknames are enabled, `firstName` is `null`.
_Available in: v23.0_
_Filter group: Small_
* `id` (_string_)
18-character ID of the user.
_Available in: v23.0_
_Filter group: Small_
* `isActive` (_boolean_)
`true` if user is active, `false` otherwise.
_Available in: v25.0_
_Filter group: Small_
* `isChatterGuest` (_boolean_)
`true` if user is a Chatter customer, `false` otherwise
In version 26.0 and later, user the `userType` property.
_Available in: v23.0–26.0_
* `isInThisCommunity` (_boolean_)
`true` if the user is in the same Experience Cloud site as the context user; `false` otherwise. Can be `false` for record feed @mentions on posts with the scope “All Users.”
_Available in: v28.0_
_Filter group: Small_
* `lastName` (_string_)
User's last name. In version 39.0 and later, if nicknames are enabled, `lastName` is `null`.
_Available in: v23.0_
_Filter group: Small_
* `motif` (_object_)
Motif
Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color.
The motif icon is not the user’s profile photo.
_Available in: v27.0_
_Filter group: Small_
Includes all fields of `Motif`.
* `mySubscription` (_object_)
ReferenceCore
If the context user is following this user, contains information about the subscription, otherwise `null`.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `name` (_string_)
Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname.
_Available in: v23.0_
_Filter group: Small_
* `outOfOffice` (_object_)
OutOfOffice
If one exists, extra out-of-office message for the user.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `OutOfOffice`.
* `photo` (_object_)
Photo
Information about the user's photo.
_Available in: v23.0_
_Filter group: Small_
Includes all fields of `Photo`.
* `reputation` (_object_)
Reputation
Reputation of the user in the site, which is determined by the number of points earned from events and actions performed in the site.
_Available in: v32.0_
_Filter group: Big_
Includes all fields of `Reputation`.
* `stamps` (_array of Stamp_)
Collection of the user’s stamps.
In version 44.0 and later, use SOQL to get a user’s stamps.
_Available in: v39.0–43.0_
_Filter group: Small_
* `title` (_string_)
Title of the user.
_Available in: v23.0_
_Filter group: Small_
* `type` (_string_)
Value is `User`.
_Available in: v23.0_
_Filter group: Small_
* `url` (_string_)
URL to the user's Chatter profile.
_Available in: v23.0_
_Filter group: Small_
* `userType` (_ConnectUserTypeEnum_)
### CommentCapabilitiesInput
Comment capabilities input.
* `content` (_object_)
ContentCapabilityInput
Content to attach to the comment.
_Available in: v32.0_
Includes all fields of `ContentCapabilityInput`.
* `feedEntityShare` (_object_)
FeedEntityShareCapabilityInput
Feed entity to share to the comment.
_Available in: v42.0_
Includes all fields of `FeedEntityShareCapabilityInput`.
* `record` (_object_)
RecordCapabilityInput
Existing knowledge article to attach to the comment.
_Available in: v42.0_
Includes all fields of `RecordCapabilityInput`.
### Vote
An upvote or downvote on a feed element or comment.
* `type` (_object_)
ConnectUpDownVoteValueEnum
Type of vote for a feed element or comment.
_Available in: v42.0_
_Filter group: Small_
Includes all fields of `ConnectUpDownVoteValueEnum`.
* `user` (_object_)
UserSummary
User who voted on the feed element or comment.
_Available in: v42.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
* `votedItem` (_object_)
Reference
Reference to the feed element or comment that was voted on.
_Available in: v42.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
### AssociatedActionsCapabilityInput
Describes action links that can be created or updated on a feed element. To associate an action link group with a feed element, the client must be the same client app that created the action link group definition and the user must either be the user who created the definition or have View all Data permission.
An action link is a button on a feed element. Clicking an action link can take a user to a Web page, initiate a file download, or invoke an API call to Salesforce or to an external server. An action link includes a URL and an HTTP method, and can include a request body and header information, such as an OAuth token for authentication. Use action links to integrate Salesforce and third-party services into the feed so that users can drive productivity and accelerate innovation.
* `actionLinkGroupIds` (_array of string_, required)
The action link group IDs to associate with the feed element. Associate one `Primary` and up to 10 total action link groups to a feed item. Action link groups are returned in the order specified in this property.
Get an action link group ID in the response from a request to /connect/action-link-group-definitions.
_Available in: v33.0_
### CanvasCapabilityInput
Create or update a canvas app associated with a feed element.
* `description` (_string_)
A description of the canvas app. The maximum size is 255 characters.
_Available in: v32.0_
* `developerName` (_string_, required)
The API name (developer name) of the client app.
_Available in: v32.0_
* `height` (_string_)
The height of the canvas app in pixels.
_Available in: v32.0_
* `namespacePrefix` (_string_)
A unique namespace prefix for the canvas app.
_Available in: v32.0_
* `parameters` (_string_)
JSON parameters passed to the canvas app.
_Available in: v32.0_
* `thumbnailUrl` (_string_)
A thumbnail URL to a preview image. The maximum thumbnail size is 120 pixels by 120 pixels.
_Available in: v32.0_
* `title` (_string_, required)
A title for the canvas link.
_Available in: v32.0_
### ContentCapabilityInput
Create or update a file associated with a comment.
To attach or remove files from a feed post (instead of a comment) in version 36.0 and later, use.
* `contentDocumentId` (_string_)
ID of the existing content.
Required for existing content. Not supported for new content
_Available in: v32.0_
* `description` (_string_)
Description of the file to be uploaded.
Optional for new content. Not supported for existing content
_Available in: v32.0_
* `sharingOption` (_object_)
ConnectFileSharingOptionEnum
Sharing option of the file. Values are:
* `Allowed` — Resharing of the file is allowed.
* `Restricted` — Resharing of the file is restricted.
_Available in: v35.0_
Includes all fields of `ConnectFileSharingOptionEnum`.
* `title` (_string_)
Title of the file. This value is used as the file name for new content. For example, if the title is My Title, and the file is a .txt file, the file name is My Title.txt.
Required for new content. Not supported for existing content
_Available in: v32.0_
### ExtensionsCapabilityInput
Create or update extensions associated with a feed element.
* `itemsToAdd` (_array of ExtensionInput_)
Collection of extensions to associate with the feed element.
Required for creating an extension (POST). Optional for updating an extension (PATCH)
_Available in: v40.0_
* `itemsToRemove` (_array of string_)
List of attachment IDs to remove from the feed element.
Optional for updating an extension (PATCH). Don’t specify for creating an extension (POST)
_Available in: v41.0_
### FeedEntityShareCapabilityInput
Share a feed entity with a feed post or comment.
* `feedEntityId` (_string_, required)
ID of the feed entity to share with the feed post or comment.
_Available in: v39.0_
### MultipleContentCapabilityInput
Attach up to 10 files that have already been uploaded or remove one or more files from a feed element.
#### XML example
```
069D00000001IOh
069D00000002IOg
```
* `items` (_array of FileIdInput_, required)
A collection of file IDs and the operations to be carried out on the files.
_Available in: v36.0_
### LinkCapabilityInput
Create or update a link attached to a feed element.
* `url` (_string_, required)
URL of the link.
_Available in: v32.0_
* `urlName` (_string_)
Name of the link.
_Available in: v32.0_
### TopicsCapabilityInput
Assign topics to a feed element.
* `contextTopicName` (_string_)
Name of the parent topic in the site to which the feed element belongs.
_Available in: v38.0_
* `topics` (_array of string_, required)
List of topics to assign to the feed element.
_Available in: v38.0_
### AbstractIdable
Describing a person or thing that can act or be acted on in the organization. Corresponds directly to an actual record in the organization with an addressible ID.
* `id` (_string (Id)_)
18-character ID of the object
_Available in: v23.0_
_Filter group: Small_
* `motif` (_object_)
Motif
Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color.
_Available in: v27.0_
_Filter group: Small_
Includes all fields of `Motif`.
* `mySubscription` (_object_)
ReferenceCore
If the context user is following this file, this contains information about the subscription, otherwise returns `null`.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `name` (_string_)
Repository name.
_Available in: v32.0_
_Filter group: Small_
* `type` (_string_)
A fixed type name for this object. Check this value to determine the shape of a response body.
_Available in: v23.0_
_Filter group: Small_
* `url` (_string (url)_)
The Connect REST API URL resource for this object.
_Available in: v23.0_
_Filter group: Small_
### EditCapability
If a feed element or comment has this capability, it can be edited by users who have permission.
* `isEditableByMeUrl` (_string (url)_)
The URL to check if the context user is able to edit this feed element or comment.
_Available in: v34.0_
_Filter group: Medium_
* `isEditRestricted` (_boolean_)
Specifies whether editing this feed element or comment is restricted. If `true`, the context user can’t edit this feed element or comment. If `false`, the context user may or may not have permission to edit this feed element or comment. To determine if a feed element or comment is editable by the context user, use the Feed Elements, Editability or Comment Capability, Editability resource.
_Available in: v34.0_
_Filter group: Small_
* `lastEditedBy` (_object_)
UserDetail
Who last edited this feed element or comment.
_Available in: v34.0_
_Filter group: Small_
Includes all fields of `UserDetail`.
* `lastEditedDate` (_string (date-time)_)
The most recent edit date of this feed element or comment. Format is ISO 8601.
_Available in: v34.0_
_Filter group: Small_
* `latestRevision` (_integer_)
The most recent revision of this feed element or comment.
_Available in: v34.0_
_Filter group: Small_
* `relativeLastEditedDate` (_string_)
Relative last edited date, for example, “2h ago.”
_Available in: v34.0_
_Filter group: Small_
### TopicsCapability
If a feed element has this capability, the context user can add topics to it. Topics help users organize and discover conversations.
* `canAssignTopics` (_boolean_)
`true` if a topic can be assigned to the feed element, `false` otherwise.
_Available in: v32.0_
_Filter group: Small_
* `items` (_array of Topic_)
A collection of topics associated with this feed element.
_Available in: v32.0_
_Filter group: Small_
### ConnectBundleTypeEnum
Defines a sub-type for the Bundle capability.
Type: `string`.
Allowed values: `GenericBundle`, `TrackedChanges`.
### FeedElementCollection
Container of feed-elements URL and isModified resource URL for a feed.
* `currentPageToken` (_string_) Page token to access the current page of feed elements.
* `currentPageUrl` (_string (url)_) URL to the current page of feed elements.
* `elements` (_array of object_)
Collection of zero or more feed elements.
See the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
Each item: See the [GET /chatter/feed-elements/{feedElementId}](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElement) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `isModifiedToken` (_string_) Since request parameter that can be used in an isModified request.
* `isModifiedUrl` (_string (url)_) A News Feed Is-Modified resource with a since request parameter that contains an opaque token that describes when the feed was last modified. Returns null if feed is not a news feed.
* `nextPageToken` (_string_) Page token to access the next page of feed elements.
* `nextPageUrl` (_string (url)_) URL to the next page of feed elements.
* `updatesToken` (_string_) Since request parameter that can be used in an updatedSince request.
* `updatesUrl` (_string (url)_) A feed resource with the feed elements updated since the feed was refreshed. Null if not supported by this feed.
### MessageSegmentInput
Input description of a message segment.
* `type` (_ConnectMessageSegmentTypeEnum_)
### DirectMessageMembershipActivity
Direct message membership activity.
* `activityDate` (_string (date-time)_)
Direct message member activity date. Format is ISO 8601.
_Available in: v40.0_
_Filter group: Small_
* `actor` (_object_)
UserSummary
User who changed the direct message membership.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
* `membersAdded` (_object_)
DirectMessageMemberCollection
Members added to the direct message as part of the activity.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `DirectMessageMemberCollection`.
* `membersRemoved` (_object_)
DirectMessageMemberCollection
Members removed from the direct message as part of the activity.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `DirectMessageMemberCollection`.
### FeedPollChoice
Feed poll choice.
* `id` (_string (Id)_)
18-character ID of the poll choice
_Available in: v26.0_
_Filter group: Small_
* `position` (_integer_)
The location in the poll where this poll choice exists. The first poll choice starts at 1.
_Available in: v26.0_
_Filter group: Small_
* `text` (_string_)
Label text associated with the poll choice
_Available in: v26.0_
_Filter group: Small_
* `voteCount` (_integer_)
Total number of votes for this poll choice
_Available in: v26.0_
_Filter group: Small_
* `voteCountRatio` (_number (double)_)
The ratio of total number of votes for this poll choice to all votes cast in the poll. Multiply the ratio by 100 to get the percentage of votes cast for this poll choice.
_Available in: v26.0_
_Filter group: Small_
### CandidateAnswersStatus
The status of candidate answers on a feed element.
* `hasCandidateAnswers` (_boolean_)
Indicates whether candidate answers are available for a question.
_Available in: v41.0_
_Filter group: Small_
* `hasCandidateAnswersPublished` (_boolean_)
Indicates whether any candidate answers are published.
_Available in: v41.0_
_Filter group: Small_
* `hasCandidateAnswersRated` (_boolean_)
Indicates whether any candidate answers are rated.
_Available in: v41.0_
_Filter group: Small_
### ReadBy
Information about who read the feed element and when.
* `lastReadDateByUser` (_string (date-time)_)
When the user last read the feed element in ISO 8601 format.
_Available in: v40.0_
_Filter group: Small_
* `user` (_object_)
UserSummary
Information about the user who read the feed element.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
### ApprovalPostTemplateField
Description of an approval post template field.
* `displayName` (_string_)
The field name
_Available in: v28.0_
_Filter group: Small_
* `displayValue` (_string_)
The field value or `null` if the field is set to `null`.
_Available in: v28.0_
_Filter group: Small_
* `record` (_object_)
Reference
A record ID
If no record exists or if the reference is `null`, this value is `null`.
_Available in: v28.0_
_Filter group: Small_
Includes all fields of `ReferenceCore`.
### ConnectWorkflowProcessStatusEnum
Status of the workflow associated with an approval post feed item attachment.
Type: `string`.
Allowed values: `Approved`, `Fault`, `Held`, `NoResponse`, `Pending`, `Reassigned`, `Rejected`, `Removed`, `Started`.
### PlatformActionGroup
A platform action group instance with state appropriate for the context user.
Action link groups are one type of platform action group and are therefore represented as platform action group response bodies.
* `category` (_object_)
ConnectPlatformActionGroupCategoryEnum
Indicates the priority and relative locations of platform actions. Values are:
* `Primary` — The action link group is displayed in the body of the feed element.
* `Overflow` — The action link group is displayed in the overflow menu of the feed element.
_Available in: v33.0_
_Filter group: Medium_
Includes all fields of `ConnectPlatformActionGroupCategoryEnum`.
* `id` (_string_)
An 18-character ID or an opaque string ID for the platform action group.
If the Platform Action `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`.
_Available in: v33.0_
_Filter group: Small_
* `modifiedDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z .
_Available in: v33.0_
_Filter group: Small_
* `platformActions` (_array of PlatformAction_)
The platform action instances for this group.
Within an action link group, action links are displayed in the order listed in the `actionLinks` property of the Action Link Group Definition Input request body. Within a feed item, action link groups are displayed in the order specified in the `actionLinkGroupIds` property of the Associated Actions Capability Input request body.
_Available in: v33.0_
_Filter group: Medium_
* `url` (_string (url)_)
Connect REST API resource URL for the platform action group.
If the Platform Action `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`.
_Available in: v33.0_
_Filter group: Small_
### Motif
The motif properties contain URLs for small, medium, and large icons that indicate the Salesforce record type. Common record types are files, users, and groups, but all record types have a set of motif icons. Custom object records use their tab style icon. All icons are available to unauthenticated users so that, for example, you can display the motif icons in an email. The motif can also contain the record type’s base color.
The motif images are icons, not user uploaded images or photos. For example, every user has the same set of motif icons. Custom object records use their tab style icon, for example, the following custom object uses the “boat” tab style: `"motif": { "color": "8C004C", "largeIconUrl": "/img/icon/custom51_100/boat64.png", "mediumIconUrl": "/img/icon/custom51_100/boat32.png", "smallIconUrl": "/img/icon/custom51_100/boat16.png", "svgIconUrl": null },` Users use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/icon/profile64.png", "mediumIconUrl": "/img/icon/profile32.png", "smallIconUrl": "/img/icon/profile16.png", "svgIconUrl": null },` Groups use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/icon/groups64.png", "mediumIconUrl": "/img/icon/groups32.png", "smallIconUrl": "/img/icon/groups16.png" },` Files use the following icons: `"motif": { "color": "1797C0", "largeIconUrl": "/img/content/content64.png", "mediumIconUrl": "/img/content/content32.png", "smallIconUrl": "/img/icon/files16.png", "svgIconUrl": null },` To view the icons in the previous examples, preface the URL with https:// `{instance_name}`. For example, https:// `{instance_name}` /img/icon/profile64.png.
* `color` (_string_)
A hex value representing the base color of the record type, or `null`.
_Available in: v29.0_
_Filter group: Small_
* `largeIconUrl` (_string_)
A large icon indicating the record type.
_Available in: v27.0_
_Filter group: Small_
* `mediumIconUrl` (_string_)
A medium icon indicating the record type.
_Available in: v27.0_
_Filter group: Small_
* `smallIconUrl` (_string_)
A small icon indicating the record type.
_Available in: v27.0_
_Filter group: Small_
* `svgIconUrl` (_string_)
An icon in SVG format indicating the record type, or `null` if the icon doesn’t exist.
_Available in: v34.0_
_Filter group: Small_
### ConnectBannerStyleEnum
A Banner is used to decorate a Feed Element at presentation time and consists of a color and set of icons.
Type: `string`.
Allowed values: `Announcement`.
### Icon
Icon.
* `height` (_integer_)
The height of the icon, in pixels
_Available in: v27.0_
_Filter group: Small_
* `url` (_string (url)_)
The URL of the icon. This URL is available to unauthenticated users. The URL doesn’t expire.
_Available in: v27.0_
_Filter group: Small_
* `width` (_integer_)
The width of the icon, in pixels
_Available in: v27.0_
_Filter group: Small_
### ConnectCaseActorTypeEnum
Specifies the type of user who made a case comment.
Type: `string`.
Allowed values: `Customer`, `CustomerService`.
### UserDetail
User detail. If the context user doesn’t have permission to see a property, the property is set to `null`.
* `aboutMe` (_string_)
Text from user's profile.
_Available in: v23.0_
_Filter group: Big_
* `additionalLabel` (_string_)
If one exists, an extra label for the user, for example, “Customer,” “Partner,” or “Acme Corporation.”
_Available in: v30.0_
_Filter group: Small_
* `address` (_object_)
Address
User’s address.
_Available in: v23.0_
_Filter group: Big_
Includes all fields of `Address`.
* `bannerPhoto` (_object_)
BannerPhoto
User’s banner photo.
_Available in: v36.0_
_Filter group: Big_
Includes all fields of `BannerPhoto`.
* `chatterActivity` (_object_)
ChatterActivity
Chatter activity statistics.
_Available in: v23.0_
_Filter group: Big_
Includes all fields of `ChatterActivity`.
* `chatterInfluence` (_object_)
ChatterInfluence
User’s influence rank.
_Available in: v23.0_
_Filter group: Big_
Includes all fields of `ChatterInfluence`.
* `communityNickname` (_string_)
User’s nickname in the site.
_Available in: v32.0_
_Filter group: Medium_
* `companyName` (_string_)
Company name.
_Available in: v23.0_
_Filter group: Small_
* `currentStatus` (_object_)
UserStatus
User's current status.
_Available in: v23.0–25.0_
Includes all fields of `UserStatus`.
* `displayName` (_string_)
User’s name that is displayed in the site. If nicknames are enabled, the nickname is displayed. If nicknames aren’t enabled, the full name is displayed.
_Available in: v32.0_
_Filter group: Small_
* `email` (_string_)
User's email address.
_Available in: v23.0_
_Filter group: Medium_
* `firstName` (_string_)
User's first name. In version 39.0 and later, if nicknames are enabled, `firstName` is `null`.
_Available in: v23.0_
_Filter group: Small_
* `followersCount` (_integer_)
Number of users following this user.
_Available in: v23.0_
_Filter group: Big_
* `followingCounts` (_object_)
FollowingCounts
Information about items the user is following.
_Available in: v23.0_
_Filter group: Big_
Includes all fields of `FollowingCounts`.
* `groupCount` (_integer_)
Number of groups user is following.
_Available in: v23.0_
_Filter group: Big_
* `hasChatter` (_boolean_)
`true` if user has access to Chatter; `false` otherwise.
_Available in: v31.0_
_Filter group: Small_
* `id` (_string_)
18-character ID of the user.
_Available in: v23.0_
_Filter group: Small_
* `isActive` (_boolean_)
`true` if user is active, `false` otherwise.
_Available in: v23.0_
_Filter group: Small_
* `isChatterGuest` (_boolean_)
`true` if user is a Chatter customer, `false` otherwise.
In version 26.0 and later, use the `userType` property.
_Available in: v23.0–25.0_
* `isInThisCommunity` (_boolean_)
`true` if the user is in the same Experience Cloud site as the context user; `false` otherwise. Can be `false` for record feed @mentions on posts with the scope “All Users.”
_Available in: v28.0_
_Filter group: Small_
* `lastName` (_string_)
User's last name. In version 39.0 and later, if nicknames are enabled, `lastName` is `null`.
_Available in: v23.0_
_Filter group: Small_
* `managerId` (_string (Id)_)
18-character ID of the user’s manager.
_Available in: v23.0_
_Filter group: Big_
* `managerName` (_string_)
Locale-based concatenation of manager's first and last names.
_Available in: v23.0_
_Filter group: Big_
* `motif` (_object_)
Motif
Small, medium, and large icons indicating that the object is a user. The motif can also contain the object’s base color.
The motif icon is not the user’s profile picture.
_Available in: v27.0_
_Filter group: Small_
Includes all fields of `Motif`.
* `mySubscription` (_object_)
ReferenceCore
If the context user is following this user, contains information about the subscription, otherwise `null`.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `name` (_string_)
Locale-based concatenation of first and last names. In version 39.0 and later, if nicknames are enabled, `name` is the nickname.
_Available in: v23.0_
_Filter group: Small_
* `outOfOffice` (_object_)
OutOfOffice
If one exists, extra out-of-office message for the user.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `OutOfOffice`.
* `phoneNumbers` (_array of PhoneNumber_)
Collection of user's phone numbers.
_Available in: v23.0_
_Filter group: Big_
* `photo` (_object_)
Photo
Information about the user's photos.
_Available in: v23.0_
_Filter group: Small_
Includes all fields of `Photo`.
* `reputation` (_object_)
Reputation
Reputation of the user in the site, which is determined by the number of points earned from events and actions performed in the site.
_Available in: v32.0_
_Filter group: Big_
Includes all fields of `Reputation`.
* `stamps` (_array of Stamp_)
Collection of the user’s stamps.
In version 44.0 and later, use SOQL to get a user’s stamps.
_Available in: v39.0–43.0_
_Filter group: Small_
* `thanksReceived` (_integer_)
Number of thanks the user has received.
_Available in: v29.0_
_Filter group: Big_
* `title` (_string_)
Title of the user.
_Available in: v23.0_
_Filter group: Small_
* `type` (_string_)
Value is `User`.
_Available in: v23.0_
_Filter group: Small_
* `url` (_string_)
URL to the user's Chatter profile.
_Available in: v23.0_
_Filter group: Small_
* `username` (_string_)
User name of the user, such as [Admin@mycompany.com](mailto:Admin@mycompany.com) .
_Available in: v24.0_
_Filter group: Small_
* `userType` (_ConnectUserTypeEnum_)
### ConnectCaseCommentEventTypeEnum
Specifies the event type of a Case's case comment.
Type: `string`.
Allowed values: `NewInternal`, `NewPublished`, `NewPublishedByCustomer`, `PublishExisting`, `PublishExistingByCustomer`, `UnpublishExistingByCustomer`, `UnpublishExsiting`.
### FilesConnectRepository
Information about a Files Connect repository.
* `authentication` (_object_)
FilesConnectRepositoryAuthentication
Repository authentication information.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `FilesConnectRepositoryAuthentication`.
* `features` (_object_)
FilesConnectRepositoryFeatures
Repository features.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `FilesConnectRepositoryFeatures`.
* `id` (_string_)
18-character ID of the external data source.
_Available in: v32.0_
_Filter group: Small_
* `label` (_string_)
Repository label.
_Available in: v32.0_
_Filter group: Small_
* `motif` (_object_)
Motif
Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color.
_Available in: v27.0_
_Filter group: Small_
Includes all fields of `Motif`.
* `mySubscription` (_object_)
ReferenceCore
If the context user is following this file, this contains information about the subscription, otherwise returns `null`.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `name` (_string_)
Repository name.
_Available in: v32.0_
_Filter group: Small_
* `providerType` (_object_)
FilesConnectProviderType
Repository provider type.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `FilesConnectProviderType`.
* `rootFolderItemsUrl` (_string (url)_)
URL to the repository root folder items, or `null` if the repository does not support browsing.
_Available in: v32.0_
_Filter group: Small_
* `type` (_string_)
Type of record, `ContentHubRepository`.
_Available in: v32.0_
_Filter group: Small_
* `url` (_string_)
Connect REST API resource URL to the Files Connect repository.
_Available in: v32.0_
_Filter group: Small_
### ConnectFileSharingOptionEnum
Sharing option of the file. Values are:
* `Allowed` — Resharing of the file is allowed.
* `Restricted` — Resharing of the file is restricted.
_Available in: v36.0_
_Filter group: Medium_
Type: `string`.
Allowed values: `Allowed`, `Restricted`.
### DashboardComponentSnapshot
Represents both dashboard component snapshots and alerts you receive when a dashboard component value crosses a threshold.
* `componentId` (_string (Id)_)
18-character ID of the dashboard component.
_Available in: v32.0_
_Filter group: Small_
* `componentName` (_string_)
The dashboard component name.
_Available in: v32.0_
_Filter group: Small_
* `dashboardBodyText` (_string_)
Display this text next to the actor in the feed element.Use this text in place of the default body text.
_Available in: v32.0_
_Filter group: Small_
* `dashboardId` (_string (Id)_)
18-character ID of the dashboard.
_Available in: v32.0_
_Filter group: Small_
* `dashboardName` (_string_)
The name of the dashboard.
_Available in: v32.0_
_Filter group: Small_
* `fullSizeImageUrl` (_string (url)_)
The source URL to retrieve the full-size image of a snapshot. Access this URL with OAuth credentials.
_Available in: v32.0_
_Filter group: Small_
* `lastRefreshDate` (_string (date-time)_)
ISO 8601 date specifying when this dashboard component was last refreshed.
_Available in: v32.0_
_Filter group: Small_
* `lastRefreshDateDisplayText` (_string_)
Display text for the last refresh date, for example, “Last Refreshed on October 31, 2013.”
_Available in: v32.0_
_Filter group: Small_
* `runningUser` (_object_)
UserSummary
The running user of the dashboard at the time the snapshot was posted. This value may be `null`. Each dashboard has a running user, whose security settings determine which data to display in a dashboard.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `UserSummary`.
* `thumbnailUrl` (_string (url)_)
The source URL to retrieve the thumbnail image of a snapshot. Access this URL with OAuth credentials.
_Available in: v32.0_
_Filter group: Small_
### EmailAttachment
An email attachment in an email message.
* `attachment` (_object_)
RecordSummary
Record summary of the attachment.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `RecordSummary`.
* `contentType` (_string_)
Type of attachment.
_Available in: v36.0_
_Filter group: Small_
* `fileName` (_string_)
Name of the attachment.
_Available in: v36.0_
_Filter group: Small_
### ConnectEmailMessageAutomationTypeEnum
If a feed element has this capability, it has an email message from a case.
_Available in: v32.0_
_Filter group: Small_
Type: `string`.
Allowed values: `AiAssisted`, `AiAutomated`.
### EmailAddress
An email address for an email message sent from a case record in Case Feed.
* `displayName` (_string_)
Display name for an email address
_Available in: v29.0_
_Filter group: Small_
* `emailAddress` (_string_)
Email address
_Available in: v29.0_
_Filter group: Small_
* `relatedRecord` (_object_)
RecordSummary
The summary of a related record, for example, a contact or user summary.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `RecordSummary`.
### ConnectEmailMessageDirectionEnum
Specifies the direction of a Case's email message.
Type: `string`.
Allowed values: `Inbound`, `Outbound`.
### ConnectEmailMessageSizeEnum
Specifies the size category of a Case's email message HTML body.
Type: `string`.
Allowed values: `Large`, `Normal`.
### ConnectEmailMessageStatusEnum
Specifies the status of a Case's email message.
Type: `string`.
Allowed values: `DraftStatus`, `ForwardedStatus`, `NewStatus`, `ReadStatus`, `RepliedStatus`, `SentStatus`.
### Extension
An extension.
* `alternativeRepresentation` (_object_)
Alternative
Alternative representation of the extension.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `Alternative`.
* `attachmentId` (_string_)
Attachment ID of the extension.
_Available in: v41.0_
_Filter group: Small_
* `extensionId` (_string_)
ID of the extension.
_Available in: v40.0_
_Filter group: Small_
* `payload` (_string_)
Payload associated with the extension.
_Available in: v40.0_
_Filter group: Small_
* `payloadVersion` (_string_)
Payload version that identifies the structure of the payload associated with the extension.
_Available in: v40.0_
_Filter group: Small_
### FeedItemSummary
Representation for a single feed item summary.
* `actor` (_AbstractActor_)
* `body` (_object_)
FeedItemBody
Information about the feed entity.
_Available in: v39.0_
_Filter group: Small_
Includes all fields of `FeedItemBody`.
* `capabilities` (_object_)
The capabilities of the feed item.
_Available in: v39.0_
_Filter group: Medium_
See the [GET /chatter/feed-elements/{feedElementId}/capabilities](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCapabilities) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `createdDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, when the entity was created.
_Available in: v39.0_
_Filter group: Small_
* `feedElementType` (_ConnectFeedElementTypeEnum_)
* `header` (_object_)
MessageBody
The header of the feed item.
_Available in: v39.0_
_Filter group: Medium_
Includes all fields of `MessageBody`.
* `id` (_string (Id)_)
18-character ID of the feed entity.
_Available in: v39.0_
_Filter group: Small_
* `isEntityAvailable` (_boolean_)
Specifies whether the entity is available. If `false`, either the user doesn’t have access to the entity or the entity was deleted.
_Available in: v39.0_
_Filter group: Small_
* `modifiedDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, when the feed item was last modified.
_Available in: v39.0_
_Filter group: Small_
* `originalFeedItem` (_object_)
Reference
A reference to the original feed item, for a shared feed item.
_Available in: v39.0_
_Filter group: Small_
Includes all fields of `ReferenceCore`.
* `originalFeedItemActor` (_object_)
AbstractActor
The actor of the original feed item, for a shared feed item.
_Available in: v39.0_
_Filter group: Medium_
Includes all fields of `AbstractActor`.
* `parent` (_AbstractIdable_)
* `photoUrl` (_string (url)_)
URL of the photo associated with the feed item.
_Available in: v39.0_
_Filter group: Medium_
* `relativeCreatedDate` (_string_)
Relative created date, for example, “2h ago.”
_Available in: v39.0_
_Filter group: Small_
* `url` (_string (url)_)
URL to the feed entity.
_Available in: v39.0_
_Filter group: Small_
* `visibility` (_object_)
ConnectFeedItemVisibilityEnum
The visibility of the feed item.
_Available in: v39.0_
_Filter group: Small_
Includes all fields of `ConnectFeedItemVisibilityEnum`.
### FeedEntityNotAvailableSummary
Representation when the feed entity is not available. The `isEntityAvailable` property is `false` and all other properties are null.
* `actor` (_AbstractActor_)
* `body` (_object_)
FeedItemBody
Information about the feed entity.
_Available in: v39.0_
_Filter group: Small_
Includes all fields of `FeedItemBody`.
* `createdDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z, when the entity was created.
_Available in: v39.0_
_Filter group: Small_
* `feedElementType` (_ConnectFeedElementTypeEnum_)
* `id` (_string (Id)_)
18-character ID of the feed entity.
_Available in: v39.0_
_Filter group: Small_
* `isEntityAvailable` (_boolean_)
The value is `false` because the user doesn’t have access to the entity or the entity was deleted.
_Available in: v39.0_
_Filter group: Small_
* `parent` (_AbstractIdable_)
* `relativeCreatedDate` (_string_)
Relative created date, for example, “2h ago.”
_Available in: v39.0_
_Filter group: Small_
* `url` (_string (url)_)
URL to the feed entity.
_Available in: v39.0_
_Filter group: Small_
### Content
A file attached to a feed item.
* `checksum` (_string_)
MD5 checksum for the file.
_Available in: v36.0_
_Filter group: Small_
* `contentHubRepository` (_object_)
FilesConnectRepository
External data source associated with this file, or `null` if it doesn’t point to an external file.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `FilesConnectRepository`.
* `contentUrl` (_string (url)_)
URL of the content for links and Google docs.
_Available in: v36.0_
_Filter group: Small_
* `description` (_string_)
Description of the attachment.
_Available in: v36.0_
_Filter group: Small_
* `downloadUrl` (_string (url)_)
URL to the content.
_Available in: v36.0_
_Filter group: Small_
* `externalDocumentUrl` (_string (url)_)
External URL this file points to, or `null` if it doesn’t point to an external file.
_Available in: v36.0_
_Filter group: Small_
* `fileExtension` (_string_)
Extension of the file.
_Available in: v36.0_
_Filter group: Small_
* `fileSize` (_string_)
Size of the file in bytes. If size can’t be determined, returns `unknown`.
_Available in: v36.0_
_Filter group: Small_
* `fileType` (_string_)
Type of file, such as PDF.
_Available in: v36.0_
_Filter group: Small_
* `hasPdfPreview` (_boolean_)
`true` if the file has a PDF preview available, `false` otherwise.
_Available in: v36.0_
_Filter group: Medium_
* `id` (_string (Id)_)
18-character ID of the content.
_Available in: v36.0_
_Filter group: Small_
* `imageDetails` (_object_)
ImageFileDetail
Image details, or `null` if the file isn’t an image.
_Available in: v40.0_
_Filter group: Big_
Includes all fields of `ImageFileDetail`.
* `isInMyFileSync` (_boolean_)
`true` if the file is synced with Salesforce Files Sync.
Salesforce Files Sync was retired on May 25, 2018.
_Available in: v36.0_
_Filter group: Small_
* `mimeType` (_string_)
MIME type of the file.
_Available in: v36.0_
_Filter group: Small_
* `renditionUrl` (_string (url)_)
URL to the rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded.
_Available in: v36.0_
_Filter group: Small_
* `renditionUrl240By180` (_string (url)_)
URL to the 240 x 180 pixel rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded.
_Available in: v36.0_
_Filter group: Small_
* `renditionUrl720By480` (_string (url)_)
URL to the 720 x 480 pixel rendition resource for the file. For shared files, renditions process asynchronously after upload. For private files, renditions process when the first file preview is requested, and aren’t available immediately after the file is uploaded.
_Available in: v36.0_
_Filter group: Small_
* `repositoryFileId` (_string_)
ID of the file in the external repository, or `null` if the file isn’t external.
_Available in: v36.0_
_Filter group: Small_
* `repositoryFileUrl` (_string (url)_)
URL to the Connect REST API resource giving access to the external repository file properties, or `null` if this file doesn’t point to an external file.
_Available in: v36.0_
_Filter group: Small_
* `sharingOption` (_object_)
ConnectFileSharingOptionEnum
Sharing option of the file. Values are:
* `Allowed` — Resharing of the file is allowed.
* `Restricted` — Resharing of the file is restricted.
_Available in: v36.0_
_Filter group: Medium_
Includes all fields of `ConnectFileSharingOptionEnum`.
* `textPreview` (_string_)
Text preview of the file if available; `null` otherwise.
_Available in: v36.0_
_Filter group: Big_
* `thumb120By90RenditionStatus` (_string_)
Specifies the rendering status of the 120 x 90 preview image of the file. One of these values:
* `Processing` — Image is being rendered.
* `Failed` — Rendering process failed.
* `Success` — Rendering process was successful.
* `Na` — Rendering is not available for this image.
_Available in: v36.0_
_Filter group: Medium_
* `thumb240By180RenditionStatus` (_string_)
Specifies the rendering status of the 240 x 180 preview image of the file. One of these values:
* `Processing` — Image is being rendered.
* `Failed` — Rendering process failed.
* `Success` — Rendering process was successful.
* `Na` — Rendering is not available for this image.
_Available in: v36.0_
_Filter group: Medium_
* `thumb720By480RenditionStatus` (_string_)
Specifies the rendering status of the 720 x 480 preview image of the file. One of these values:
* `Processing` — Image is being rendered.
* `Failed` — Rendering process failed.
* `Success` — Rendering process was successful.
* `Na` — Rendering is not available for this image.
_Available in: v36.0_
_Filter group: Medium_
* `title` (_string_)
Title of the file.
_Available in: v36.0_
_Filter group: Small_
* `versionId` (_string (Id)_)
Version ID of the file.
_Available in: v36.0_
_Filter group: Medium_
### MediaReference
A media reference.
* `mediaUrl` (_string (url)_)
URL to stream or download the media.
_Available in: v41.0_
_Filter group: Small_
* `thumbnailUrl` (_string (url)_)
If one exists, URL of the media’s thumbnail.
_Available in: v41.0_
_Filter group: Small_
### EntityRecommendation
Representation of a single recommendation object that is a Salesforce record with an ID.
* `action` (_object_)
ConnectRecommendationActionEnum
Specifies the action to take on the recommendation. Values are:
* `follow` (v23.0)
* `join` (v23.0)
* `view` (v25.0)
_Available in: v23.0_
_Filter group: Small_
Includes all fields of `ConnectRecommendationActionEnum`.
* `actOnUrl` (_string (url)_)
For user, file, group, topic, and record entity types, use this Connect REST URL with a POST request to follow the recommended user, file, topic, or record, or join the recommended group. For recommended object entity types, such as custom recommendations, use the `actionUrl` property of the response body to take action on the recommendation.
_Available in: v23.0_
_Filter group: Small_
* `entity` (_object_)
AbstractActor
The entity with which the receiver is recommended to take action.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `AbstractActor`.
* `explanation` (_object_)
RecExplanationSummary
The recommendation explanation.
_Available in: v23.0_
_Filter group: Big_
Includes all fields of `RecExplanationSummary`.
* `platformActionGroup` (_PlatformActionGroup_)
* `recommendationType` (_ConnectRecommendationTypeEnum_)
* `url` (_string (url)_) Url to the connect resource for the recommendation.
### RecordView
A view of any record in the org, including a custom object record. This object is used if a specialized object, such as User or ChatterGroup, isn’t available for the record type. Contains data and metadata so you can render a record with one response.
* `id` (_string_)
18-character ID of the object
_Available in: v23.0_
_Filter group: Small_
* `motif` (_object_)
Motif
Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color.
_Available in: v27.0_
_Filter group: Small_
Includes all fields of `Motif`.
* `mySubscription` (_object_)
ReferenceCore
If the context user is following this file, this contains information about the subscription, otherwise returns `null`.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `name` (_string_)
The localized name
_Available in: v29.0_
_Filter group: Small_
* `relatedListDefinitions` (_array of ListViewDefinition_)
Related list definitions (metadata) for this object. These list definitions don’t include the related list data.
_Available in: v29.0_
_Filter group: Medium_
* `sections` (_array of RecordViewSection_)
List of record view sections.
_Available in: v29.0_
_Filter group: Small_
* `type` (_string_)
A fixed type name for this object. Check this value to determine the shape of a response body.
_Available in: v23.0_
_Filter group: Small_
* `url` (_string_)
The Connect REST API URL resource for this object.
_Available in: v23.0_
_Filter group: Small_
### SocialAccount
A social account on a social network.
* `externalSocialAccountId` (_string_)
ID of the external social account, if available.
_Available in: v38.0_
_Filter group: Small_
* `handle` (_string_)
Social handle, screen name, or alias that identifies this account.
_Available in: v36.0_
_Filter group: Small_
* `name` (_string_)
Name of the account as defined by the account's owner.
_Available in: v36.0_
_Filter group: Small_
* `profileUrl` (_string (url)_)
URL to the account's profile.
_Available in: v36.0_
_Filter group: Small_
* `socialPersonaId` (_string_)
ID of the social persona account, if the external social account ID isn’t available.
_Available in: v39.0_
_Filter group: Small_
### ConnectSocialPostMessageTypeEnum
The message type of a social post.
Type: `string`.
Allowed values: `Comment`, `Direct`, `Post`, `PrivateMessage`, `Reply`, `Retweet`, `Tweet`.
### ConnectSocialNetworkProviderEnum
The social network provider.
Type: `string`.
Allowed values: `Facebook`, `GooglePlus`, `Instagram`, `InstagramBusiness`, `KakaoTalk`, `Kik`, `Line`, `LinkedIn`, `Messenger`, `Other`, `Pinterest`, `QQ`, `Rypple`, `SMS`, `SinaWeibo`, `Snapchat`, `Telegram`, `Twitter`, `VKontakte`, `WeChat`, `WhatsApp`, `YouTube`.
### SocialPostStatus
The status of a social post.
* `message` (_string_)
Status message.
_Available in: v36.0_
_Filter group: Small_
* `type` (_object_)
ConnectSocialPostStatusTypeEnum
Status type.
_Available in: v36.0_
_Filter group: Small_
Includes all fields of `ConnectSocialPostStatusTypeEnum`.
### FeedTrackedChange
Feed tracked change.
* `fieldName` (_string_)
The name of the field that was updated.
_Available in: v29.0_
_Filter group: Small_
* `newValue` (_string_)
The new value of the field or `null` if the field length is long or empty.
_Available in: v29.0_
_Filter group: Small_
* `oldValue` (_string_)
The old value of the field or `null` if the field length is long or empty.
_Available in: v29.0_
_Filter group: Small_
### AbstractRelatedFeedPost
A related feed post
* `id` (_string_)
18-character ID of the related question.
_Available in: v37.0_
_Filter group: Small_
* `motif` (_object_)
Motif
Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color.
_Available in: v27.0_
_Filter group: Small_
Includes all fields of `Motif`.
* `mySubscription` (_object_)
ReferenceCore
If the context user is following this file, this contains information about the subscription, otherwise returns `null`.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `mySubscriptions` (_object_)
ReferenceCore
If the context user is following the item, it contains information about the subscription. Otherwise, it returns `null`.
_Available in: v37.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `name` (_string_)
Name of the related question.
_Available in: v37.0_
_Filter group: Small_
* `score` (_number (double)_)
Score of the related feed post that indicates how closely related it is to the context feed post.
_Available in: v37.0_
_Filter group: Small_
* `title` (_string_)
Title of the related feed post.
_Available in: v37.0_
_Filter group: Small_
* `type` (_string_)
Value is `RelatedQuestion`.
_Available in: v37.0_
_Filter group: Small_
* `url` (_string_)
URL to the related question.
_Available in: v37.0_
_Filter group: Small_
### FeedDirectoryItem
The definition of a feed.
* `feedElementsUrl` (_string (url)_)
URL to the resource of the feed elements for a specific feed. For example: `/chatter/feeds/files/me/feed-elements`
_Available in: v31.0_
_Filter group: Small_
* `feedType` (_object_)
ConnectFeedType
The feed type. One of these values:
* `Bookmarks` — Contains all feed items saved as bookmarks by the context user.
* `Company` — Contains all feed items except feed items of type `TrackedChange`. To see the feed item, the user must have sharing access to its parent.
* `DirectMessageModeration` — Contains all direct messages that are flagged for moderation. The Direct Message Moderation feed is available only to users with Moderate Experiences Chatter Messages permissions.
* `DirectMessages` — Contains all feed items of the context user’s direct messages.
* `Draft` — Contains all the feed items that the context user drafted.
* `Files` — Contains all feed items that contain files posted by people or groups that the context user follows.
* `Filter` — Contains the news feed filtered to contain feed items whose parent is a specified object type.
* `Groups` — Contains all feed items from all groups the context user either owns or is a member of.
* `Home` — Contains all feed items associated with any managed topic in an Experience Cloud site.
* `Isolated` — Contains all the feed items and comments that are isolated.
* `Landing` — Contains all feed items that best drive user engagement when the feed is requested. Allows clients to avoid an empty feed when there aren’t many personalized feed items.
* `Moderation` — Contains all feed items that are flagged for moderation, except direct messages. The moderation feed is available only to users with Moderate Experiences Feeds permissions.
* `Mute` — Contains all feed items that the context user muted.
* `News` — Contains all updates for people the context user follows, groups the user is a member of, and files and records the user is following. Contains all updates for records whose parent is the context user.
* `PendingReview` — Contains all feed items and comments that are pending review.
* `People` — Contains all feed items posted by all people the context user follows.
* `Record` — Contains all feed items whose parent is a specified record, which could be a group, user, object, file, or any other standard or custom object. When the record is a group, the feed also contains feed items that mention the group. When the record is a user, the feed contains only feed items on that user. You can get another user’s record feed.
* `Streams` — Contains all feed items for any combination of up to 25 feed-enabled entities that the context user subscribes to in a stream. Examples of feed-enabled entities include people, groups, and records,
* `To` — Contains all feed items with mentions of the context user. Contains feed items the context user commented on and feed items created by the context user that are commented on.
* `Topics` — Contains all feed items that include the specified topic.
* `UserProfile` — Contains feed items created when a user changes records that can be tracked in a feed. Contains feed items whose parent is the user and feed items that @mention the user. This feed is different than the news feed, which returns more feed items, including group updates. You can get another user’s user profile feed.
_Available in: v30.0_
_Filter group: Big_
Includes all fields of `ConnectFeedType`.
* `feedUrl` (_string (url)_)
URL to the resource of a specific feed. For example: `/services/data/v67.0/chatter/feeds/files/me`
_Available in: v23.0_
_Filter group: Small_
* `keyPrefix` (_string_)
For filter feeds, this value is the key prefix associated with the object type used to filter this feed. All feed items in this feed have a parent whose object type matches this key prefix value. For non-filter feeds, this value is `null`.
A key prefix is the first three characters of a record ID, which specifies the object type.
_Available in: v30.0_
_Filter group: Big_
* `label` (_string_)
Name of the feed, such as, Groups, People, Company, and so on
_Available in: v23.0_
_Filter group: Small_
* `feedItemsUrl` (_string_)
URL to the resource of the feed items for a specific feed. For example: `/chatter/feeds/files/me/feed-elements`
_Available in: v23.0–31.0_
_Filter group: Small_
### ModerationFlagsCollection
Collection of flags on a feed item, comment, or file.
* `currentPageToken` (_string_)
Token identifying the current page.
_Available in: v40.0_
_Filter group: Small_
* `currentPageUrl` (_string (url)_)
Connect REST API URL identifying the current page.
_Available in: v40.0_
_Filter group: Small_
* `flags` (_array of ModerationFlagItem_)
List of flag details.
_Available in: v40.0_
_Filter group: Small_
* `nextPageToken` (_string_)
Token identifying the next page, or `null` if there isn’t a next page.
_Available in: v40.0_
_Filter group: Small_
* `nextPageUrl` (_string (url)_)
Connect REST API URL identifying the next page, or `null` if there isn’t a next page.
_Available in: v40.0_
_Filter group: Small_
* `pageSize` (_integer_)
Number of items per page.
_Available in: v40.0_
_Filter group: Small_
### ConnectFeedFilter
Filter for the feed specified in `redirectedFeedType`. Otherwise, `null`.
_Available in: v42.0_
_Filter group: Small_
Type: `string`.
Allowed values: `AllQuestions`, `AuthoredBy`, `CommunityScoped`, `QuestionsWithCandidateAnswers`, `QuestionsWithCandidateAnswersReviewedPublished`, `Read`, `SolvedQuestions`, `UnansweredQuestions`, `UnansweredQuestionsWithCandidateAnswers`, `Unread`, `UnsolvedQuestions`.
### ConnectFeedType
The feed type. One of these values:
* `Bookmarks` — Contains all feed items saved as bookmarks by the context user.
* `Company` — Contains all feed items except feed items of type `TrackedChange`. To see the feed item, the user must have sharing access to its parent.
* `DirectMessageModeration` — Contains all direct messages that are flagged for moderation. The Direct Message Moderation feed is available only to users with Moderate Experiences Chatter Messages permissions.
* `DirectMessages` — Contains all feed items of the context user’s direct messages.
* `Draft` — Contains all the feed items that the context user drafted.
* `Files` — Contains all feed items that contain files posted by people or groups that the context user follows.
* `Filter` — Contains the news feed filtered to contain feed items whose parent is a specified object type.
* `Groups` — Contains all feed items from all groups the context user either owns or is a member of.
* `Home` — Contains all feed items associated with any managed topic in an Experience Cloud site.
* `Isolated` — Contains all the feed items and comments that are isolated.
* `Landing` — Contains all feed items that best drive user engagement when the feed is requested. Allows clients to avoid an empty feed when there aren’t many personalized feed items.
* `Moderation` — Contains all feed items that are flagged for moderation, except direct messages. The moderation feed is available only to users with Moderate Experiences Feeds permissions.
* `Mute` — Contains all feed items that the context user muted.
* `News` — Contains all updates for people the context user follows, groups the user is a member of, and files and records the user is following. Contains all updates for records whose parent is the context user.
* `PendingReview` — Contains all feed items and comments that are pending review.
* `People` — Contains all feed items posted by all people the context user follows.
* `Record` — Contains all feed items whose parent is a specified record, which could be a group, user, object, file, or any other standard or custom object. When the record is a group, the feed also contains feed items that mention the group. When the record is a user, the feed contains only feed items on that user. You can get another user’s record feed.
* `Streams` — Contains all feed items for any combination of up to 25 feed-enabled entities that the context user subscribes to in a stream. Examples of feed-enabled entities include people, groups, and records,
* `To` — Contains all feed items with mentions of the context user. Contains feed items the context user commented on and feed items created by the context user that are commented on.
* `Topics` — Contains all feed items that include the specified topic.
* `UserProfile` — Contains feed items created when a user changes records that can be tracked in a feed. Contains feed items whose parent is the user and feed items that @mention the user. This feed is different than the news feed, which returns more feed items, including group updates. You can get another user’s user profile feed.
_Available in: v30.0_
_Filter group: Big_
Type: `string`.
Allowed values: `Bookmarks`, `Company`, `DirectMessageModeration`, `DirectMessages`, `Draft`, `Files`, `Filter`, `Groups`, `Home`, `Isolated`, `Landing`, `Moderation`, `Muted`, `News`, `PendingReview`, `People`, `Record`, `Streams`, `To`, `Topics`, `UserProfile`.
### AbstractFeedElementCapability
In v30.0 and prior, every Feed Item could be commented on, liked, assigned topics, etc. In v31.0 and after, features exist that disable or change certain attributes of Feed Items and Comments. For example, a question post adds the capability to mark a certain Comment as the best Comment. Capabilities are a way to extensibly declare which actions/attributes are allowed on Feed Items and Elements. Important: The existence of the Capability on a Feed Element (and any associated data with that Feed Element Capability), indicates that the Capability is available. For example, the "ChatterLikes" Capability object will exist only on Feed Elements where it is possible to like that Element. Capabilities are bound to an API version range and won't appear in older API versions where they didn't used to appear.
### TopicImagesSbi
Images associated with a topic.
* `coverImageUrl` (_string_)
URL to a topic’s cover image, which appears on the topic page. Both topics and managed topics can have cover images.
_Available in: v32.0_
_Filter group: Small_
* `featuredImageUrl` (_string_)
URL to a managed topic’s featured image, which appears wherever you feature it, for example, on your Experience Cloud site home page.
_Available in: v32.0_
_Filter group: Small_
### MessageSegment
Superclass of all message segment representations.
* `text` (_string_)
Empty string, `""`, for segments of this type.
_Available in: v35.0_
_Filter group: Small_
* `type` (_ConnectMessageSegmentTypeEnum_)
### RecordCapability
If a comment has this capability, it has a record attachment.
* `recordId` (_string_)
ID of the record.
_Available in: v42.0_
_Filter group: Small_
* `url` (_string_)
URL to the record.
_Available in: v42.0_
_Filter group: Small_
### OutOfOffice
User's out-of-office message.
* `message` (_string_)
Out-of-office message for the user.
_Available in: v40.0_
_Filter group: Small_
### Photo
Photo.
* `fullEmailPhotoUrl` (_string (url)_)
A temporary URL to the large profile picture that expires after 30 days. This URL is available to unauthenticated users.
_Available in: v27.0_
_Filter group: Medium_
* `largePhotoUrl` (_string (url)_)
URL to the large profile picture. The default width is 200 pixels, while the length is scaled so the original image proportions are maintained.
If a user hasn’t uploaded a photo, this URL points to a default photo. If the user hasn’t uploaded a photo and the request header included X-Connect-Theme: Salesforce1, this URL points to a default photo based on a theme that the admin selected for the org.
_Available in: v23.0_
_Filter group: Medium_
* `mediumPhotoUrl` (_string (url)_)
URL to the medium profile picture. The default width is 160 pixels, and the height is scaled so the original image proportions are maintained.
If a user hasn’t uploaded a photo, this URL points to a default photo. If the user hasn’t uploaded a photo and the request header included X-Connect-Theme: Salesforce1, this URL points to a default photo based on a theme that the admin selected for the org.
_Available in: v37.0_
_Filter group: Small_
* `photoVersionId` (_string (Id)_)
18-character ID to that version of the photo.
_Available in: v24.0_
_Filter group: Small_
* `smallPhotoUrl` (_string (url)_)
URL to the small profile picture. The default size is 64x64 pixels.
If a user hasn’t uploaded a photo, this URL points to a default photo. If the user hasn’t uploaded a photo and the request header included X-Connect-Theme: Salesforce1, this URL points to a default photo based on a theme that the admin selected for the org.
_Available in: v23.0_
_Filter group: Small_
* `standardEmailPhotoUrl` (_string (url)_)
A temporary URL to the small profile picture that expires after 30 days. This URL is available to unauthenticated users.
_Available in: v27.0_
_Filter group: Small_
* `url` (_string (url)_)
URL to a resource that returns a Photo response body: for example, `/services/data/v67.0/chatter/users/005D0000001LL8OIAW/photo`.
_Available in: v27.0_
_Filter group: Small_
### Reputation
Reputation for a user.
* `reputationLevel` (_object_)
ReputationLevel
User’s reputation level.
_Available in: v32.0_
_Filter group: Small_
Includes all fields of `ReputationLevel`.
* `reputationPoints` (_number (double)_)
User's reputation points, which can be earned by performing different activities.
_Available in: v32.0_
_Filter group: Small_
* `url` (_string (url)_)
Connect REST API URL to the reputation.
_Available in: v32.0_
_Filter group: Small_
### Stamp
A user stamp.
* `description` (_string_)
Description of the stamp.
_Available in: v39.0–43.0_
_Filter group: Small_
* `id` (_string_)
ID of the stamp.
_Available in: v39.0–43.0_
_Filter group: Small_
* `imageUrl` (_string_)
Image URL of the stamp.
_Available in: v39.0–43.0_
_Filter group: Small_
* `label` (_string_)
Label of the stamp.
_Available in: v39.0–43.0_
_Filter group: Small_
### ConnectUserTypeEnum
If the record represented by this completion is a user, this value is the user type associated with that user; otherwise the value is `null`.
Values are:
* `ChatterGuest` — User is an external user in a private group.
* `ChatterOnly` — User is a Chatter Free customer.
* `Guest` — User is unauthenticated.
* `Internal` — User is a standard org member.
* `Portal` — User is an external user in an Experience Cloud site.
* `System` — User is Chatter Expert or a system user.
* `Undefined` — User is a user type that is a custom object.
_Available in: v30.0_
_Filter group: Medium_
Type: `string`.
Allowed values: `ChatterGuest`, `ChatterOnly`, `Guest`, `Internal`, `Portal`, `System`, `Undefined`.
### RecordCapabilityInput
Attach an existing knowledge article to a comment.
* `recordId` (_string_, required)
ID of the existing knowledge article to attach.
_Available in: v42.0_
### ExtensionInput
An extension.
* `alternativeRepresentation` (_object_, required)
AlternativeInput
Alternative representation of the extension.
_Available in: v40.0_
Includes all fields of `AlternativeInput`.
* `extensionId` (_string_, required)
ID of the extension.
_Available in: v40.0_
* `payload` (_string_, required)
Payload associated with the extension.
_Available in: v40.0_
* `payloadVersion` (_string_)
Payload version that identifies the structure of the payload associated with the extension.
_Available in: v40.0_
### FileIdInput
Attach a file that has already been uploaded or remove a file from a feed element.
#### XML example
```
069D00000001IOh
```
* `id` (_string_, required)
ID of a file that has already been uploaded.
_Available in: v36.0_
* `operationType` (_object_)
ConnectOperationTypeEnum
Operation to carry out on the file. Values are:
* `Add` — Adds the file to the feed element.
* `Remove` — Removes the file from the feed element.
`Remove` operations are processed before `Add` operations. Adding content that is already added and removing content that is already removed result in no operation.
If not specified, defaults to `Add`.
_Available in: v36.0_
Includes all fields of `ConnectOperationTypeEnum`.
### Topic
Topic.
* `createdDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z
_Available in: v28.0_
_Filter group: Big_
* `description` (_string_)
Description of the topic
_Available in: v28.0_
_Filter group: Big_
* `id` (_string (Id)_)
18-character ID of the topic
_Available in: v28.0_
_Filter group: Small_
* `images` (_object_)
TopicImages
Images associated with the topic
_Available in: v32.0_
_Filter group: Medium_
Includes all fields of `TopicImages`.
* `isBeingDeleted` (_boolean_)
`true` if the topic is currently being deleted; `false` otherwise.
After the topic is deleted, when attempting to retrieve the topic, the response is 404: Not Found.
_Available in: v33.0_
_Filter group: Small_
* `name` (_string_)
Name of the topic
_Available in: v28.0_
_Filter group: Small_
* `nonLocalizedName` (_string_)
Non-localized name of the topic
_Available in: v36.0_
_Filter group: Medium_
* `talkingAbout` (_integer_)
Number of people talking about this topic over the last two months, based on factors such as topic additions and comments on posts with the topic
_Available in: v28.0_
_Filter group: Medium_
* `url` (_string (url)_)
URL to the topic detail page
_Available in: v29.0_
_Filter group: Small_
### ConnectMessageSegmentTypeEnum
Feed items may have complex information within the post and is therefore broken into rich segments each containing complex information stored in the feed body. Specifies the type of segment and the additional information within.
Type: `string`.
Allowed values: `EntityLink`, `FieldChange`, `FieldChangeName`, `FieldChangeValue`, `Hashtag`, `InlineImage`, `Link`, `MarkupBegin`, `MarkupEnd`, `Mention`, `MoreChanges`, `ResourceLink`, `Text`.
### ConnectPlatformActionGroupCategoryEnum
Indicates the priority and relative locations of platform actions. Values are:
* `Primary` — The action link group is displayed in the body of the feed element.
* `Overflow` — The action link group is displayed in the overflow menu of the feed element.
_Available in: v33.0_
_Filter group: Medium_
Type: `string`.
Allowed values: `Overflow`, `Primary`.
### PlatformAction
A platform action instance with state information for the context user.
Action links are one type of platform action and are therefore represented as platform action response bodies.
* `actionUrl` (_string (url)_)
For action links of `subtype` `Ui` or `Download`, direct the user to download or visit the UI from this link. Salesforce issues a Javascript redirect for the link in this format: `/action-link-redirect/{communityId}/{actionLinkId}?_bearer={bearerToken}`.
For `Api` and `ApiAsync` action links and for all platform actions, this value is `null`.
Salesforce handles the callout to `Api` or and `ApiAsync` action links.
To call an `Api` or an `ApiAsync` action link, you can also make a PATCH request to the /connect/action-links/actionLinkId resource and set `status` to `PendingStatus`.
_Available in: v33.0_
_Filter group: Medium_
* `apiName` (_string_)
The API name. This value may be `null`.
_Available in: v33.0_
_Filter group: Medium_
* `confirmationMessage` (_string_)
If this action requires a confirmation and has a status of `NewStatus`, this is a default localized message that should be shown to an end user prior to invoking the action. Otherwise, this is `null`.
_Available in: v33.0_
_Filter group: Medium_
* `createdRecords` (_array of RecordSummary_)
The collection of records that this action created after it was invoked by the context user. This collection is empty if the action hasn’t been performed yet by the context user or if the action doesn’t create a record. Only records created by the context user are shown.
_Available in: v33.0_
_Filter group: Medium_
* `executingUser` (_object_)
UserSummary
User who initiated execution of the platform action.
_Available in: v33.0_
_Filter group: Medium_
Includes all fields of `UserSummary`.
* `groupDefault` (_boolean_)
`true` if this platform action is the default or primary platform action in the platform action group; `false` otherwise. There can be only one default platform action per platform action group.
_Available in: v33.0_
_Filter group: Small_
* `iconUrl` (_string (url)_)
The URL of the icon for the platform action. This value may be `null`.
_Available in: v33.0_
_Filter group: Medium_
* `id` (_string_)
The ID of the platform action.
If the `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`.
_Available in: v33.0_
_Filter group: Small_
* `label` (_string_)
The localized label for this platform action.
_Available in: v33.0_
_Filter group: Small_
* `modifiedDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z
_Available in: v33.0_
_Filter group: Small_
* `platformActionGroup` (_object_)
Reference
A reference to the platform action group containing this platform action.
_Available in: v33.0_
_Filter group: Small_
Includes all fields of `ReferenceCore`.
* `status` (_object_)
ConnectPlatformActionStatusEnum
The execution status of the platform action. Values are:
* `FailedStatus` — The action link execution failed.
* `NewStatus` — The action link is ready to be executed. Available for `Download` and `Ui` action links only.
* `PendingStatus` — The action link is executing. Choosing this value triggers the API call for `Api` and `ApiAsync` action links.
* `SuccessfulStatus` — The action link executed successfully.
For action links only, you can update the `status` by making a PATCH request to the `/connect/action-links/{actionLinkId}` resource.
_Available in: v33.0_
_Filter group: Small_
Includes all fields of `ConnectPlatformActionStatusEnum`.
* `subtype` (_string_)
The subtype of a platform action or `null`.
If the `type` property is `ActionLink`, possible values are:
* `Api` — The action link calls a synchronous API at the action URL. Salesforce sets the status to `SuccessfulStatus` or `FailedStatus` based on the HTTP status code returned by your server.
* `ApiAsync` — The action link calls an asynchronous API at the action URL. The action remains in a `PendingStatus` state until a third party makes a request to `/connect/action-links/{actionLinkId}` to set the status to `SuccessfulStatus` or `FailedStatus` when the asynchronous operation is complete.
* `Download` — The action link downloads a file from the action URL.
* `Ui` — The action link takes the user to a web page at the action URL.
_Available in: v33.0_
_Filter group: Small_
* `type` (_object_)
ConnectPlatformActionTypeEnum
The type of platform action. Values are:
* `ActionLink` — An indicator on a feed element that targets an API, a web page, or a file, represented by a button in the Salesforce UI.
* `CustomButton` — When clicked, opens a URL or a Visualforce page in a window or executes JavaScript.
* `ProductivityAction` — Productivity actions are predefined and attached to a limited set of objects. Productivity actions include Send Email, Call, Map, View Website, and Read News. Except for the Call action, you can’t edit productivity actions.
* `QuickAction` — A global or object-specific action.
* `StandardButton` — A predefined Salesforce button such as New, Edit, or Delete.
_Available in: v33.0_
_Filter group: Small_
Includes all fields of `ConnectPlatformActionTypeEnum`.
* `url` (_string (url)_)
Connect REST API resource URL for the platform action.
If the `type` is `QuickAction` and the `subtype` is `Create`, this value is `null`.
_Available in: v33.0_
_Filter group: Small_
### Address
Address input representation for a payment method, payment intent, or card payment method.
* `city` (_string_)
City
_Available in: v49.0_
* `country` (_string_)
Country, specified using the ISO country code.
_Available in: v49.0_
* `formattedAddress` (_string_)
Address formatted by locale
_Available in: v25.0_
_Filter group: Small_
* `state` (_string_)
State
_Available in: v49.0_
* `street` (_string_)
Street
_Available in: v49.0_
* `zip` (_string_)
Zip or postal code
_Available in: v23.0_
_Filter group: Small_
* `companyName` (_string_)
Company name
_Available in: v49.0_
* `postalCode` (_string_)
Postal code
_Available in: v49.0_
### BannerPhoto
A banner photo.
* `bannerPhotoUrl` (_string (url)_)
URL to the banner photo in a large format. This URL is available only to authenticated users.
_Available in: v36.0_
_Filter group: Medium_
* `bannerPhotoVersionId` (_string (Id)_)
18-character version ID of the banner photo.
_Available in: v36.0_
_Filter group: Small_
* `url` (_string (url)_)
URL to the banner photo.
_Available in: v36.0_
_Filter group: Small_
### ChatterActivity
Chatter activity, such as the number of posts and comments made, and comments, likes, and upvotes received, for a user.
* `commentCount` (_integer_)
Total number of comments in the org or site made by the user.
_Available in: v23.0_
_Filter group: Small_
* `commentReceivedCount` (_integer_)
Total number of comments in the org or site received by the user.
_Available in: v23.0_
_Filter group: Small_
* `likeReceivedCount` (_integer_)
Total number of likes and upvotes (in version 45.0 and later) on posts and comments in the org or site received by the user.
_Available in: v23.0_
_Filter group: Small_
* `postCount` (_integer_)
Total number of posts in the org or site made by the user.
_Available in: v23.0_
_Filter group: Small_
### ChatterInfluence
Chatter influence.
* `percentile` (_string_)
Percentile value for the user’s influence rank within the org or Experience Cloud site.
_Available in: v24.0_
_Filter group: Small_
* `rank` (_integer_)
Number indicating the user’s influence rank, relative to all other users within the org or Experience Cloud site.
_Available in: v24.0_
_Filter group: Small_
### UserStatus
User status.
* `body` (_object_)
FeedBody
Body of the post
_Available in: v23.0–25.0_
_Filter group: Small_
Includes all fields of `FeedBody`.
* `parentId` (_string (Id)_)
18-character ID
_Available in: v23.0–25.0_
_Filter group: Small_
* `url` (_string (url)_)
URL to this user status post
_Available in: v23.0–25.0_
_Filter group: Small_
### FollowingCounts
Chatter following counts.
* `people` (_integer_)
Number of people the user is following
_Available in: v23.0_
_Filter group: Small_
* `records` (_integer_)
Number of records the user is following
Topics are a type of record that can be followed as of version 29.0.
_Available in: v23.0_
_Filter group: Small_
* `total` (_integer_)
Total number of items the user is following
_Available in: v23.0_
_Filter group: Small_
### PhoneNumber
A phone number.
* `label` (_string_)
Localized string indicating the phone type
_Available in: v30.0_
_Filter group: Small_
* `phoneNumber` (_string_)
Phone number
_Available in: v27.0_
_Filter group: Small_
* `phoneType` (_string_)
Phone type. One of these values:
* `Fax`
* `Mobile`
* `Work`
These values are not localized.
_Available in: v30.0_
_Filter group: Small_
* `number` (_string_)
This property is not available after version 26.0. Use the `phoneNumber` property instead.
Phone number
_Available in: v23.0–26.0_
* `type` (_string_)
This property is not available after version 29.0. Use the `phoneType` property instead.
Values are:
* `Fax`
* `Mobile`
* `Work`
_Available in: v23.0–29.0_
_Filter group: Small_
### FilesConnectRepositoryAuthentication
Authentication information for a repository.
* `authFlowUrl` (_string_)
Depends on the `authProtocol`.
* `NoAuthentication` — `null`.
* `Oauth` — URL to start the OAuth flow.
* `Password` — URL to the authentication settings for external systems.
_Available in: v40.0_
_Filter group: Small_
* `authProtocol` (_object_)
ConnectContenHubAuthenticationProtocolEnum
Authentication protocol used for the repository. Values are:
* `NoAuthentication` — Repository doesn’t require authentication.
* `Oauth` — Repository uses OAuth authentication protocol.
* `Password` — Repository uses user name and password authentication protocol.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `ConnectContenHubAuthenticationProtocolEnum`.
* `userHasAuthSettings` (_boolean_)
Specifies whether the user has credentials or the administrator configured the external data source to use the same set of credentials for every user (`true`). Otherwise, `false`.
_Available in: v40.0_
_Filter group: Small_
### FilesConnectRepositoryFeatures
Information about the features of a Files Connect repository.
* `canBrowse` (_boolean_)
Specifies whether the repository’s folder hierarchy can be browsed (`true`) or not (`false`).
_Available in: v32.0_
_Filter group: Small_
* `canSearch` (_boolean_)
Specifies whether the repository can be searched (`true`) or not (`false`).
_Available in: v32.0_
_Filter group: Small_
### FilesConnectProviderType
Information about the Files Connect provider.
* `label` (_string_)
Localized label of the provider type.
_Available in: v32.0_
_Filter group: Small_
* `type` (_string_)
Provider type. One of these values:
* `ContentHubBox`
* `ContentHubGDrive`
* `ContentHubSharepoint`
* `ContentHubSharepointOffice365`
* `ContentHubSharepointOneDrive`
* `SimpleUrl`
_Available in: v32.0_
_Filter group: Small_
### RecordSummary
Record summary.
* `entityLabel` (_object_)
EntityLabel
Label of the record’s entity.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `EntityLabel`.
* `id` (_string_)
18-character ID of the record.
_Available in: v23.0_
_Filter group: Small_
* `motif` (_object_)
Motif
Small, medium, and large icons indicating the type of the object. The motif can also contain the object’s base color.
_Available in: v27.0_
_Filter group: Small_
Includes all fields of `Motif`.
* `mySubscription` (_object_)
ReferenceCore
If the context user is following this file, this contains information about the subscription, otherwise returns `null`.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `name` (_string_)
The localized name .
_Available in: v23.0_
_Filter group: Small_
* `type` (_string_)
Type of record, such as `CustomObject` or `ContentDocument`.
_Available in: v23.0_
_Filter group: Small_
* `url` (_string_)
Relative URL to this record.
_Available in: v23.0_
_Filter group: Small_
### Alternative
Alternative representation for an extension on a feed element.
* `textRepresentation` (_string_)
Text representation of the extension.
_Available in: v40.0_
_Filter group: Small_
* `thumbnailUrl` (_string_)
Thumbnail URL to the extension.
_Available in: v40.0_
_Filter group: Small_
* `title` (_string_)
Title of the extension.
_Available in: v40.0_
_Filter group: Small_
### AbstractActor
Describing a person or thing that can act or be acted on in the organization. May or may not correspond to an actual record in the organization, as some actors, such as certain system users, are synthetic in nature.
* `name` (_string_)
Repository name.
_Available in: v32.0_
_Filter group: Small_
* `type` (_string_)
A fixed type name for this object. Check this value to determine the shape of a response body.
_Available in: v23.0_
_Filter group: Small_
### MessageBody
Representation for a structured text item.
* `isRichText` (_boolean_) Whether this is a rich text body.
* `messageSegments` (_array of MessageSegment_) Collection of message segments, based on type. The segment types you may encounter will depend on the body type.
* `text` (_string_) Unformatted text of the message. This can be an easy summary to use if you don't want to process the message segments.
### ImageFileDetail
Image file details.
* `height` (_integer_)
Image’s height in pixels.
_Available in: v39.0_
_Filter group: Small_
* `imageFormat` (_string_)
Image’s format.
_Available in: v39.0_
_Filter group: Small_
* `orientation` (_string_)
Image’s EXIF orientation value, if present.
_Available in: v39.0_
_Filter group: Small_
* `width` (_integer_)
Image’s width in pixels.
_Available in: v39.0_
_Filter group: Small_
### ConnectRecommendationActionEnum
Specifies the type of action to take from a recommendation.
Type: `string`.
Allowed values: `follow`, `join`, `view`.
### RecExplanationSummary
Explanation for a system-generated recommendations of Chatter actions for the logged-in user.
* `detailsUrl` (_string (url)_) URL for explanation details. If the recommendation doesn’t have a detailed explanation, the string “null”.
* `summary` (_string_) Explanation of recommendation.
* `type` (_ConnectRecommendationExplanationEnum_)
### ConnectRecommendationTypeEnum
Specifies the type of record that is the subject of a recommendation.
Type: `string`.
Allowed values: `apps`, `articles`, `custom`, `files`, `groups`, `records`, `topics`, `users`.
### ListViewDefinition
Related list structure or a search list structure on a record view. There’s no data in the list.
* `columns` (_array of ListViewColumn_)
The columns of fields shown in this list view.
_Available in: v29.0_
_Filter group: Big_
* `label` (_string_)
The localized label of this list view.
_Available in: v29.0_
_Filter group: Small_
* `objectType` (_object_)
ListViewObject
The definition of the type of the objects in this list view.
_Available in: v29.0_
_Filter group: Medium_
Includes all fields of `ListViewObject`.
* `rowLimit` (_integer_)
The maximum number of objects per page in this list view. To view all objects in this related list, page through the data in pages no larger than this size. To build a SOQL statement from this describe, the SOQL statement must include a LIMIT value equal to this value or an error is thrown on execution.
_Available in: v29.0_
_Filter group: Medium_
* `sortColumns` (_array of ListViewSort_)
The columns in which to sort this list view. The sort columns are given in the order of their priority (for example, primary sort, secondary sort, and so on).
_Available in: v29.0_
_Filter group: Medium_
### RecordViewSection
Section of record fields and values on a record detail.
* `columnCount` (_integer_)
Number of columns to use to lay out the fields in a record section.
_Available in: v29.0_
_Filter group: Small_
* `columnOrder` (_string_)
Order of the fields to use in the `fields` property to lay out the fields in a record section.
* `LeftRight` — Fields are rendered from left to right.
* `TopDown` — Fields are rendered from the top down.
_Available in: v29.0_
_Filter group: Small_
* `fields` (_array of RecordField | Blank | Compound | Currency | Date | Percent | Picklist | Reference | ReferenceWithDate_)
Fields and values for the record contained in this section. A collection of these response bodies:
* Record Field
* Record Field: Blank
* Record Field: Compound
* Record Field: Currency
* Record Field: Date
* Record Field: Percent
* Record Field: Picklist
* Record Field: Reference
* Record Field: Reference with Date
_Available in: v29.0_
_Filter group: Small_
* `heading` (_string_)
Localized label to display when rendering this section of fields.
_Available in: v29.0_
_Filter group: Small_
* `isCollapsible` (_boolean_)
Indicates whether the section can be collapsed to hide all the fields (`true`) or not (`false`).
_Available in: v29.0_
_Filter group: Small_
### ConnectSocialPostStatusTypeEnum
Status type.
_Available in: v36.0_
_Filter group: Small_
Type: `string`.
Allowed values: `ApprovalPending`, `ApprovalRecalled`, `ApprovalRejected`, `Deleted`, `Failed`, `Hidden`, `Pending`, `Replied`, `Sent`, `Unknown`.
### ModerationFlagItem
Flag details on a feed item, comment, or file.
* `createdBy` (_string_)
ID of the user who flagged the item.
_Available in: v40.0_
_Filter group: Small_
* `createdDate` (_string (date-time)_)
Date when the item was flagged. Format is ISO 8601.
_Available in: v40.0_
_Filter group: Small_
* `id` (_string (Id)_)
ID of the moderation flag.
_Available in: v40.0_
_Filter group: Small_
* `moderationType` (_object_)
ConnectNetworkModerationTypeEnum
Type of moderation flag. Values are:
* `FlagAsInappropriate` — Flag for inappropriate content.
* `FlagAsSpam` — Flag for spam.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `ConnectNetworkModerationTypeEnum`.
* `note` (_string_)
Note from user who flagged the item.
_Available in: v40.0_
_Filter group: Small_
* `visibility` (_object_)
ConnectNetworkModerationVisibilityEnum
Visibility behavior of a flag for various user types. Values are:
* `ModeratorsOnly` — The flag is visible only to users with moderation permissions on the flagged element or item.
* `SelfAndModerators` — The flag is visible to the creator of the flag and to users with moderation permissions on the flagged element or item.
_Available in: v40.0_
_Filter group: Small_
Includes all fields of `ConnectNetworkModerationVisibilityEnum`.
### ReputationLevel
Reputation level for a user.
* `levelImageUrl` (_string (url)_)
URL to the reputation level image.
_Available in: v32.0_
_Filter group: Small_
* `levelName` (_string_)
Name of the reputation level.
_Available in: v32.0_
_Filter group: Small_
* `levelNumber` (_integer_)
Reputation level number, which is the numerical rank of the level, with the lowest level at 1. Administrators define the reputation level point ranges.
_Available in: v32.0_
_Filter group: Small_
### AlternativeInput
Alternative representation for an extension on a feed element.
* `textRepresentation` (_string_, required)
Text representation of the extension.
_Available in: v40.0_
* `thumbnailUrl` (_string_)
Thumbnail URL to the extension.
_Available in: v40.0_
* `title` (_string_)
Title of the extension.
_Available in: v40.0_
### ConnectOperationTypeEnum
Operation to carry out on the file. Values are:
* `Add` — Adds the file to the feed element.
* `Remove` — Removes the file from the feed element.
`Remove` operations are processed before `Add` operations. Adding content that is already added and removing content that is already removed result in no operation.
If not specified, defaults to `Add`.
_Available in: v36.0_
Type: `string`.
Allowed values: `Add`, `Remove`.
### TopicImages
Images associated with a topic.
* `coverImageUrl` (_string (url)_)
URL to a topic’s cover image, which appears on the topic page. Both topics and managed topics can have cover images.
_Available in: v32.0_
_Filter group: Small_
* `featuredImageUrl` (_string (url)_)
URL to a managed topic’s featured image, which appears wherever you feature it, for example, on your Experience Cloud site home page.
_Available in: v32.0_
_Filter group: Small_
### ConnectPlatformActionStatusEnum
The execution status of the platform action. Values are:
* `FailedStatus` — The action link execution failed.
* `NewStatus` — The action link is ready to be executed. Available for `Download` and `Ui` action links only.
* `PendingStatus` — The action link is executing. Choosing this value triggers the API call for `Api` and `ApiAsync` action links.
* `SuccessfulStatus` — The action link executed successfully.
For action links only, you can update the `status` by making a PATCH request to the `/connect/action-links/{actionLinkId}` resource.
_Available in: v33.0_
_Filter group: Small_
Type: `string`.
Allowed values: `FailedStatus`, `NewStatus`, `PendingStatus`, `SuccessfulStatus`.
### ConnectPlatformActionTypeEnum
The type of platform action. Values are:
* `ActionLink` — An indicator on a feed element that targets an API, a web page, or a file, represented by a button in the Salesforce UI.
* `CustomButton` — When clicked, opens a URL or a Visualforce page in a window or executes JavaScript.
* `ProductivityAction` — Productivity actions are predefined and attached to a limited set of objects. Productivity actions include Send Email, Call, Map, View Website, and Read News. Except for the Call action, you can’t edit productivity actions.
* `QuickAction` — A global or object-specific action.
* `StandardButton` — A predefined Salesforce button such as New, Edit, or Delete.
_Available in: v33.0_
_Filter group: Small_
Type: `string`.
Allowed values: `ActionLink`, `CustomButton`, `ProductivityAction`, `QuickAction`, `StandardButton`.
### FeedBody
Information about the feed item.
* `isRichText` (_boolean_) Whether this is a rich text body.
* `messageSegments` (_array of MessageSegment_) Collection of message segments, based on type. The segment types you may encounter will depend on the body type.
* `text` (_string_) Unformatted text of the message. This can be an easy summary to use if you don't want to process the message segments.
### ConnectContenHubAuthenticationProtocolEnum
Authentication protocol used for the repository. Values are:
* `NoAuthentication` — Repository doesn’t require authentication.
* `Oauth` — Repository uses OAuth authentication protocol.
* `Password` — Repository uses user name and password authentication protocol.
_Available in: v40.0_
_Filter group: Small_
Type: `string`.
Allowed values: `NoAuthentication`, `Oauth`, `Password`.
### EntityLabel
An entity's label.
* `label` (_string_)
Localized singular label of the entity.
_Available in: v40.0_
_Filter group: Small_
* `labelPlural` (_string_)
Localized plural label of the entity.
_Available in: v40.0_
_Filter group: Small_
### ConnectRecommendationExplanationEnum
Indicates the reason-type for a suggested recommendation.
Type: `string`.
Allowed values: `ArticleHasRelatedContent`, `ArticleViewedTogether`, `ArticleViewedTogetherWithViewers`, `Custom`, `FilePopular`, `FileViewedTogether`, `FollowedTogetherWithFollowees`, `GroupMembersFollowed`, `GroupNew`, `GroupPopular`, `ItemViewedTogether`, `PopularApp`, `RecordOwned`, `RecordParentOfFollowed`, `RecordViewed`, `TopicFollowedTogether`, `TopicFollowedTogetherWithFollowees`, `TopicPopularFollowed`, `TopicPopularLiked`, `UserDirectReport`, `UserFollowedTogether`, `UserFollowsSameUsers`, `UserManager`, `UserNew`, `UserPeer`, `UserPopular`, `UserViewingSameRecords`.
### ListViewColumn
Single column of a record’s related list. Describes how to lay out the column; doesn’t contain the column’s data.
* `dataType` (_string_)
The object type for this column’s field. This is the object type used in REST API and SOAP API.
_Available in: v29.0_
_Filter group: Medium_
* `fieldId` (_string_)
The fully qualified API field ID, for example, `Contact.Name`.
_Available in: v29.0_
_Filter group: Big_
* `label` (_string_)
The localized label of this column.
_Available in: v29.0_
_Filter group: Small_
* `name` (_string_)
The short name of the API field, for example, `Name`.
_Available in: v29.0_
_Filter group: Medium_
### ListViewObject
Type of record displayed in the rows of a related list.
* `fieldId` (_string_)
The API field ID that refers to the parent record. For example, if an Account record has a related list of Contact records, then in the Contact related list definition on the Account this value might be `"Account"`.
_Available in: v29.0_
_Filter group: Big_
* `type` (_string_)
The object type name for this object. This is the object type used in REST API and SOAP API.
_Available in: v29.0_
_Filter group: Small_
### ListViewSort
Ordinal of a sort order in a related list.
* `column` (_string_)
The field ID on the related list column to sort.
_Available in: v29.0_
_Filter group: Small_
* `order` (_object_)
ConnectSortOrderEnum
The order in which to sort the column. One of these values:
* `Ascending` — Items are in ascending alphabetical order (A-Z).
* `Descending` — Items are in descending alphabetical order (Z-A).
* `MostRecentlyViewed` — Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.
_Available in: v29.0_
_Filter group: Small_
Includes all fields of `ConnectSortOrderEnum`.
### RecordField
Generic record field containing a label and text value.
* `label` (_string_)
Localized string describing the record field.
_Available in: v29.0_
_Filter group: Small_
* `text` (_string_)
Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case.
_Available in: v29.0_
_Filter group: Small_
* `type` (_string_)
Valid values are:
* `Boolean`
* `Email`
* `Number`
* `Phone`
* `Text`
_Available in: v29.0_
_Filter group: Small_
### Blank
Record field displayed as a place holder in a grid of fields.
* `type` (_string_)
_Available in: v29.0_
_Filter group: Small_
### Compound
Record field that is a composite of subfields.
* `fields` (_array of RecordField | Blank | Compound | Currency | Date | Percent | Picklist | Reference | ReferenceWithDate_)
Collection of subfields that make up the compound field. A collection of these response bodies:
* Record Field
* Record Field: Blank
* Record Field: Compound
* Record Field: Currency
* Record Field: Date
* Record Field: Percent
* Record Field: Picklist
* Record Field: Reference
* Record Field: Reference with Date
_Available in: v29.0_
_Filter group: Big_
* `label` (_string_)
Localized string describing the record field.
_Available in: v29.0_
_Filter group: Small_
* `text` (_string_)
Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case.
_Available in: v29.0_
_Filter group: Small_
* `type` (_string_)
Valid values are:
* `Address`
* `Compound`
* `Location`
* `Name`
_Available in: v29.0_
_Filter group: Small_
### Currency
Record field containing a currency value.
* `label` (_string_)
Localized string describing the record field.
_Available in: v29.0_
_Filter group: Small_
* `text` (_string_)
Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case.
Currency is formatted in the default currency of the organization.
_Available in: v29.0_
_Filter group: Small_
* `type` (_string_)
_Available in: v29.0_
_Filter group: Small_
### Date
Record field containing a date.
* `dateValue` (_string_)
Date that a machine can read. Format is ISO 8601.
_Available in: v29.0_
_Filter group: Medium_
* `label` (_string_)
Localized string describing the record field.
_Available in: v29.0_
_Filter group: Small_
* `text` (_string_)
Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case.
_Available in: v29.0_
_Filter group: Small_
* `type` (_string_)
Valid values are:
* `Date`
* `DateTime`
* `Time`
_Available in: v29.0_
_Filter group: Small_
### Percent
Record field containing a percentage value.
* `value` (_number (double)_)
Value of the percentage.
_Available in: v29.0_
_Filter group: Medium_
* `label` (_string_)
Localized string describing the record field.
_Available in: v29.0_
_Filter group: Small_
* `text` (_string_)
Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case.
_Available in: v29.0_
_Filter group: Small_
* `type` (_string_)
_Available in: v29.0_
_Filter group: Small_
### Picklist
Record field containing an enumerated value.
* `label` (_string_)
Localized string describing the record field.
_Available in: v29.0_
_Filter group: Small_
* `text` (_string_)
Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case.
_Available in: v29.0_
_Filter group: Small_
* `type` (_string_)
_Available in: v29.0_
_Filter group: Small_
### Reference
Record field containing a reference to another object.
* `label` (_string_)
Localized string describing the record field.
_Available in: v29.0_
_Filter group: Small_
* `reference` (_object_)
ReferenceCore
Object referenced by the record field.
_Available in: v29.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `text` (_string_)
Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case.
_Available in: v29.0_
_Filter group: Small_
* `type` (_string_)
_Available in: v29.0_
_Filter group: Small_
### ReferenceWithDate
Record field containing a referenced object that acted at a specific time, for example, “Created By...”.
* `dateValue` (_string_)
Time at which the referenced object acted. Format is ISO 8601.
_Available in: v29.0_
_Filter group: Medium_
* `label` (_string_)
Localized string describing the record field.
_Available in: v29.0_
_Filter group: Small_
* `reference` (_object_)
ReferenceCore
Object referenced by the record field.
_Available in: v29.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `text` (_string_)
Text value of the record field. All record fields have a text value. To ensure that all clients can consume new content, inspect the record field’s `type` property. If it isn’t recognized, render the text value as the default case.
_Available in: v29.0_
_Filter group: Small_
* `type` (_string_)
Valid values are:
* `CreatedBy`
* `LastModifiedBy`
_Available in: v29.0_
_Filter group: Small_
### ConnectSortOrderEnum
The order in which to sort the column. One of these values:
* `Ascending` — Items are in ascending alphabetical order (A-Z).
* `Descending` — Items are in descending alphabetical order (Z-A).
* `MostRecentlyViewed` — Items are in descending chronological order by view. This sort order is valid only for Chatter feed streams.
_Available in: v29.0_
_Filter group: Small_
Type: `string`.
Allowed values: `Ascending`, `Descending`, `MostRecentlyViewed`.
### FeedItem
A feed is made up of feed elements. A feed item is a type of feed element.
* `actor` (_object_, required)
AbstractActor
The entity that created the feed item. Values are:
* Record Summary —if a record (23.0)
* User Summary —if a user (23.0)
* Unauthenticated User —if a Chatter customer (24.0)
If the actor is a user, a User Summary response body is returned, not a Record Summary of type user.
_Filter group: Small_
Includes all fields of `AbstractActor`.
* `attachment` (_string_)
Depends on the `type` value of the attachment. Values include:
* `Approval` — Feed Item Attachment: Approval (v27.0–31.0)
* `BasicTemplate` — Feed Item Attachment: Basic Template (v27.0–31.0)
* `Canvas` — Feed Item Attachment: Canvas Template (v29.0–31.0)
* `CaseComment` — Feed Item Attachment: Case Comment (v24.0–31.0)
* `Content` — Feed Item Attachment: Content or `null` if the content is unavailable (v23.0–31.0)
* `DashboardComponent` — Feed Item Attachment: Dashboard (v24.0–31.0)
* `EmailMessage` — Feed Item Attachment: Email Message (v29.0–31.0)
* `Link` — Feed Item Attachment: Link (v23.0–31.0)
* `Poll` — Feed Item Attachment: Poll (v26.0–31.0)
* `RecordSnapshot` — Feed Item Attachment: Record Snapshot (v29.0–31.0)
* `TrackedChange` — Feed Item Attachment: Tracked Change (v29.0–31.0)
**Important**: As of API version 32.0, use the `capabilities` property.
_Filter group: Medium_
* `body` (_object_)
FeedItemBody
Information about the feed element.
_Available in: v22.0_
_Filter group: Small_
Includes all fields of `FeedItemBody`.
* `canShare` (_boolean_)
Indicates whether the feed item can be shared.
If a feed item has multiple file attachments and at least one attachment has been deleted or is inaccessible, the feed item can’t be shared. The `canShare` value is incorrectly set to `true` in these cases.
**Important**: As of API version 39.0, use the `isSharable` property.
_Available in: v27.0–38.0_
_Filter group: Medium_
* `capabilities` (_object_, required)
A container for all capabilities that can be included with a feed element.
_Available in: v31.0_
_Filter group: Medium_
See the [GET /chatter/feed-elements/{feedElementId}/capabilities](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCapabilities) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `clientInfo` (_object_)
ClientInfo
Information about the client app used to authenticate the connection.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `ClientInfo`.
* `comments` (_object_)
Comments for this feed item.
**Important**: As of API version 32.0, use the `capabilities.comments.page` property.
_Available in: v23.0–31.0_
_Filter group: Small_
See the [GET /chatter/feed-elements/{feedElementId}/capabilities/comments/items](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getCommentsCapabilityItems) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `createdDate` (_string_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z
_Available in: v23.0_
_Filter group: Small_
* `currentUserLike` (_object_)
ReferenceCore
**Note**: This property is no longer available as of version 24.0. Use the `myLike` property instead.
A reference to a like object if applicable, `null` otherwise.
_Available in: v23.0–24.0_
Includes all fields of `ReferenceCore`.
* `event` (_boolean_)
`true` if feed item created due to an event change, `false` otherwise.
_Available in: v23.0_
_Filter group: Medium_
* `feedElementType` (_object_)
ConnectFeedElementTypeEnum
Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values:
* `Bundle` — A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values.
* `FeedItem` — A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values.
* `Recommendation` — A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user.
_Available in: v31.0_
Example: `FeedItem`.
Includes all fields of `ConnectFeedElementTypeEnum`.
Example: `FeedItem`.
* `hasVerifiedComment` (_boolean_)
`true` if the feed item has a verified comment, otherwise `false`.
_Available in: v41.0_
_Filter group: Small_
* `header` (_object_, required)
FeedItemBody
The header is the title of the post. This property contains renderable plain text for all the segments of the message. If a client doesn't know how to render a feed element type, it should render this text.
_Available in: v31.0_
_Filter group: Medium_
Includes all fields of `FeedItemBody`.
* `id` (_string_, required)
18-character ID of the feed item.
_Available in: v23.0_
_Filter group: Small_
* `isBookmarkedByCurrentUser` (_boolean_)
`true` if the context user has bookmarked this feed item, `false` otherwise.
**Important**: As of API version 32.0, use the `capabilities.bookmarks.isBookmarkedByCurrentUser` property.
_Available in: v24.0–31.0_
_Filter group: Medium_
* `isDeleteRestricted` (_boolean_)
Returns `true` if the context user can’t delete a feed item. If it returns `false`, possibly the context users can delete the feed item.
_Available in: v25.0_
_Filter group: Medium_
* `isLikedByCurrentUser` (_boolean_)
`true` if the context user has liked this feed item, `false` otherwise.
As of API version 32.0, use the `capabilities.chatterLikes.isLikedByCurrentUser` property.
_Available in: v23.0–31.0_
_Filter group: Medium_
* `isSharable` (_boolean_)
Indicates whether the feed item can be shared.
_Available in: v39.0_
_Filter group: Medium_
* `likes` (_object_)
LikePage
Likes for this feed item,
**Important**: As of API version 32.0, use the `capabilities.chatterLikes.page` property.
_Available in: v23.0–31.0_
_Filter group: Medium_
Includes all fields of `LikePage`.
* `likesMessage` (_object_)
LikeMessageBody
A message body that describes who likes the feed item.
As of API version 32.0, use the `capabilities.chatterLikes.likesMessage` property.
_Available in: v27.0–31.0_
_Filter group: Small_
Includes all fields of `LikeMessageBody`.
* `moderationFlags` (_object_)
ModerationFlags
Flags for this feed item. Moderators can view and act on flagged items.
If the `communityModeration` property of the Features response body is `false`, this property is `null`.
**Important**: As of API version 32.0, use the `capabilities.moderation.moderationFlags` property.
_Available in: v29.0–31.0_
_Filter group: Big_
Includes all fields of `ModerationFlags`.
* `modifiedDate` (_string_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z .
_Available in: v23.0_
_Filter group: Small_
* `myLike` (_object_)
ReferenceCore
If the context user has liked the comment, this property is a reference to the specific like, `null` otherwise.
**Important**: As of API version 32.0, use the `capabilities.chatterLikes.myLike` property.
_Available in: v23.0–31.0_
_Filter group: Medium_
Includes all fields of `ReferenceCore`.
* `originalFeedItem` (_object_)
Reference
A reference to the original feed item if this feed item is a shared feed item, `null` otherwise.
_Available in: v24.0_
_Filter group: Small_
Includes all fields of `ReferenceCore`.
* `originalFeedItemActor` (_object_)
AbstractActor
Value depends on type of original feed item. Values are:
* Record Summary –if original feed item is a record
* User Summary –if original feed item is a user
* Unauthenticated User —if original feed item is from a Chatter customer
* `null` if this feed item is not a shared feed item
_Available in: v24.0_
_Filter group: Medium_
Includes all fields of `AbstractActor`.
* `parent` (_object_, required)
AbstractIdable
Value depends on type of parent. Values are:
* File Summary—if parent is a file
* Group—if parent is a group
* Record Summary—if parent is a record
* User Summary—if parent is a user
**Note**: If the parent is a user, a User Summary response body is returned, not a Record Summary of type user. The same applies for both groups and files.
_Available in: v23.0_
_Filter group: Medium_
Includes all fields of `AbstractIdable`.
* `photoUrl` (_string (url)_)
URL of the photo associated with the feed item.
_Available in: v23.0_
_Filter group: Medium_
* `preamble` (_string_)
The preamble is the title of the post. This property contains renderable plain text for all the segments of the message, for example, “App Builders - Pam Jones”.
In API versions to 28.0, use the `/body/text` property as the default case for rendering text. In API versions 29.0–30.0, use the `/preamble/text` property as the default case for rendering text. In API versions 31.0 and later, use the `/header/text` property as the default case for rendering text.
_Available in: v27.0–30.0_
_Filter group: Medium_
* `relativeCreatedDate` (_string_)
Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” .
_Available in: v28.0_
_Filter group: Small_
* `topics` (_object_)
FeedItemTopics
Topics for this feed item.
**Important**: As of API version 32.0, use the `capabilities.topics.items` property.
_Available in: v28.0–31.0_
_Filter group: Medium_
Includes all fields of `FeedItemTopics`.
* `type` (_object_)
ConnectFeedItemTypeEnum
The `type` property always returns all types, regardless of API version. However, not all types are valid with all API versions.
**Important**: As of API version 32.0, use the `capabilities` property to determine what can be done with a feed item. See [Feeds and Feed Elements](/docs/platform/connect-rest-api/guide/features_feeds_feed_elements#capabilities).
Values are:
* `ActivityEvent` — Feed item generated in Case Feed when an event or task associated with a parent record with a feed enabled is created or updated.
* `AdvancedTextPost` — A feed item with advanced text formatting, such as a group announcement post.
* `ApprovalPost` — Feed item with an approval capability. Approvers can act on the feed item parent.
* `AttachArticleEvent` — Feed item generated when an article is attached to a case in Case Feed.
* `BasicTemplateFeedItem` — Feed item with an enhanced link capability.
* `CallLogPost` — Feed item generated when a call log is saved to a case in Case Feed.
* `CanvasPost` — Feed item generated by a canvas app in the publisher or from Connect REST API or Connect in Apex. The post itself is a link to a canvas app.
* `CaseCommentPost` — Feed item generated when a case comment is saved in Case Feed.
* `ChangeStatusPost` — Feed item generated when the status of a case is changed in Case Feed.
* `ChatTranscriptionPost` — Feed item generated in Case Feed when a Live Agent chat transcript is saved to a case.
* `CollaborationGroupCreated` — Feed item generated when a new public group is created. Contains a link to the new group.
* `CollaborationGroupUnarchived` — Deprecated. Feed item generated when an archived group is activated.
* `ContentPost` — Feed item with a content capability.
* `CreateRecordEvent` — Feed item that describes a record created in the publisher.
* `DashboardComponentAlert` — Feed item with a dashboard alert.
* `DashboardComponentSnapshot` — Feed item with a dashboard component snapshot capability.
* `EmailMessageEvent` — Feed item generated when an email is sent from a case in Case Feed.
* `FacebookPost` — Deprecated. Feed item generated when a Facebook post is created from a case in Case Feed.
* `LinkPost` — Feed item with a link capability.
* `MilestoneEvent` — Feed item generated when a case milestone is either completed or reaches a violation status. Contains a link to the case milestone.
* `PollPost` — Feed item with a poll capability. Viewers of the feed item are allowed to vote on the options in the poll.
* `ProfileSkillPost` — Feed item generated when a skill is added to a user’s profile.
* `QuestionPost` — Feed item generated when a question is asked. As of API version 33.0, a feed item of this type can have a content capability and a link capability.
* `ReplyPost` — Feed item generated by a Chatter Answers reply.
* `RypplePost` — Feed item generated when a user posts thanks.
* `SocialPost` — Feed item generated when a social post is created from a case in Case Feed.
* `TextPost` — Feed item containing text only.
* `TrackedChange` — Feed item created when one or more fields on a record have been changed.
* `UserStatus` — Deprecated. A user's post to their own profile.
_Available in: v23.0_
_Filter group: Small_
Includes all fields of `ConnectFeedItemTypeEnum`.
* `url` (_string_)
URL to this feed item.
_Available in: v23.0_
_Filter group: Small_
* `visibility` (_object_)
ConnectFeedItemVisibilityEnum
Who can see this feed item. Values are:
* `InternalUsers` — If digital experiences is enabled, only members of the default, internal site can see the feed item.
* `AllUsers` — If digital experiences is enabled, all members of the site can see the feed item.
_Available in: v26.0_
_Filter group: Small_
Includes all fields of `ConnectFeedItemVisibilityEnum`.
### TrackedChangeBundleCapability
If a feed element has this capability, it has a group of other feed elements aggregated into one feed element called a bundle. This type of bundle aggregates feed tracked changes.
Bundled posts contain feed-tracked changes and are in record feeds only.
* `bundleType` (_object_)
ConnectBundleTypeEnum
Type of bundle.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `ConnectBundleTypeEnum`.
* `changes` (_array of FeedTrackedChange_)
Collection of feed tracked changes.
_Available in: v31.0_
_Filter group: Small_
* `page` (_object_)
FeedElementCollection
A collection of feed elements.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `FeedElementCollection`.
* `totalElements` (_integer_)
The total number of feed elements that this bundle aggregates.
_Available in: v31.0_
_Filter group: Small_
### GenericBundleCapability
If a feed element has this capability, the feed element may be a group of other feed elements condensed into one.
Bundled posts contain feed-tracked changes and are in record feeds only.
* `bundleType` (_object_)
ConnectBundleTypeEnum
Type of bundle.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `ConnectBundleTypeEnum`.
* `page` (_object_)
FeedElementCollection
A collection of feed elements.
_Available in: v31.0_
_Filter group: Small_
Includes all fields of `FeedElementCollection`.
* `totalElements` (_integer_)
The total number of feed elements that this bundle aggregates.
_Available in: v31.0_
_Filter group: Small_
### FeedItemTopics
Feed item topics.
**Important**: This response body isn’t available in version 32.0 and later. In version 32.0 and later, Topics Capability is used.
* `canAssignTopics` (_boolean_)
`true` if a topic can be assigned to the feed item, `false` otherwise
_Available in: v28.0–31.0_
_Filter group: Small_
* `topics` (_array of Topic_)
Collection of topics
_Available in: v28.0–31.0_
_Filter group: Small_
### ConnectFeedItemTypeEnum
Specifies the type of a feed item.
Type: `string`.
Allowed values: `ActivityEvent`, `AdvancedTextPost`, `AnnouncementPost`, `ApprovalPost`, `AttachArticleEvent`, `AttachExternalDocumentEvent`, `BasicTemplateFeedItem`, `CallLogPost`, `CanvasPost`, `CaseCommentPost`, `ChangeStatusPost`, `ChatTranscriptPost`, `CollaborationGroupCreated`, `CollaborationGroupUnarchived`, `ContentPost`, `CreateRecordEvent`, `DashboardComponentAlert`, `DashboardComponentSnapshot`, `EmailMessageEvent`, `FacebookPost`, `LinkPost`, `MilestoneEvent`, `PollPost`, `ProfileSkillPost`, `QuestionPost`, `ReplyPost`, `RypplePost`, `SocialPost`, `TestItem`, `TextPost`, `TrackedChange`, `UserStatus`.
### FeedElement
A concrete instance of a generic Feed Element. Unless otherwise specified, a generic Feed Element can have shared properties: id, feedElementType, body, and capabilities.
* `body` (_object_)
FeedItemBody
Information about the feed element.
_Available in: v22.0_
_Filter group: Small_
Includes all fields of `FeedItemBody`.
* `capabilities` (_object_, required)
A container for all capabilities that can be included with a feed element.
_Available in: v31.0_
_Filter group: Medium_
See the [GET /chatter/feed-elements/{feedElementId}/capabilities](/docs/platform/connect-rest-api/references/connect-rest-api-chatter-feeds#tag/Feed-Elements-Resources/operation/getFeedElementCapabilities) operation for the full schema. This field is shown empty in this operation's Response samples but is populated in actual API responses.
* `createdDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z
_Available in: v23.0_
_Filter group: Small_
* `feedElementType` (_object_)
ConnectFeedElementTypeEnum
Feed elements are the top-level objects that a feed contains. The feed element type describes the characteristics of that feed element. One of these values:
* `Bundle` — A container of feed elements. A bundle also has a body made up of message segments that can always be gracefully degraded to text-only values.
* `FeedItem` — A feed item has a single parent and is scoped to oneExperience Cloud site or across all Experience Cloud sites. A feed item can have capabilities such as bookmarks, canvas, content, comment, link, poll. Feed items have a body made up of message segments that can always be gracefully degraded to text-only values.
* `Recommendation` — A recommendation is a feed element with a recommendations capability. A recommendation suggests records to follow, groups to join, or applications that are helpful to the context user.
_Available in: v31.0_
Includes all fields of `ConnectFeedElementTypeEnum`.
* `header` (_object_, required)
FeedItemBody
The header is the title of the post. This property contains renderable plain text for all the segments of the message. If a client doesn't know how to render a feed element type, it should render this text.
_Available in: v31.0_
_Filter group: Medium_
Includes all fields of `FeedItemBody`.
* `id` (_string (Id)_, required)
18-character ID of the feed item.
_Available in: v23.0_
_Filter group: Small_
* `modifiedDate` (_string (date-time)_)
ISO 8601 date string, for example, 2011-02-25T18:24:31.000Z .
_Available in: v23.0_
_Filter group: Small_
* `parent` (_object_, required)
AbstractIdable
The parent of the feed element.
_Available in: v28.0_
_Filter group: Medium_
Includes all fields of `AbstractIdable`.
* `relativeCreatedDate` (_string_)
Created date formatted as a relative, localized string, for example, “17m ago” or “Yesterday.” .
_Available in: v28.0_
_Filter group: Small_
* `url` (_string (url)_)
URL to this feed item.
_Available in: v23.0_
_Filter group: Small_