User Profile Feed Resources

Returns a URL to the feed elements for the user profile feed.

Resource

1/chatter/feeds/user-profile/me

or

1/chatter/feeds/user-profile/userId

Available since version

23.0

Requires Chatter

Yes

HTTP methods

GET or HEAD

Request parameters

Parameter Name	Type	Description
sort	String	Specifies the order returned by the sort, such as by date created or last modified: CreatedDateDesc—Sorts by most recent creation date. LastModifiedDateDesc—Sorts by most recent activity. The default value is CreatedDescDate.

Response body

Feed

Returns the feed elements for all actions on all records that can be tracked in a feed.

Resource

1/chatter/feeds/user-profile/me/feed-elements

or

1/chatter/feeds/user-profile/userId/feed-elements

Available since version

31.0

Requires Chatter

Yes

HTTP methods

GET, HEAD

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
density	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. FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of, but hides some system-generated updates from records. The default value is AllUpdates.	Optional	31.0
elementsPerBundle	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 are available through a pilot program. For information, contact Salesforce. During the pilot, bundles contain only feed-tracked changes. Note	Optional	31.0
page	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, for example: 1"nextPageUrl": 2"/services/data/v32.0/ 3chatter/feeds/news/ 4005D0000001GLowIAN 5/feed-elements 6?page=2011-03-30T17:34:50Z, 70D5D0000000DSv4KAG"	Optional	31.0
pageSize	Integer	Specifies the number of feed elements per page. Valid values are between 1 and 100. The default value is 25.	Optional	31.0
q	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.	Optional	31.0
recentComment​Count	Integer	Maximum number of comments to include per feed element. The default value is 3. The maximum value is 25.	Optional	31.0
sort	String	Specifies the order returned by the sort, such as by date created or last modified: CreatedDateDesc—Sorts by most recent creation date. LastModifiedDateDesc—Sorts by most recent activity. The default value is CreatedDescDate.	Optional	31.0

Response body for GET

Feed Element Page

Returns the feed items for all actions on all records that can be tracked in a feed. You can also use this resource to post a new feed item.

For information about posting a feed item, see Using POST, PATCH, or PUT for Input.

To upload a binary file, you must send it as a body part in a multipart/form-data request. You can send information such as the text of a post or comment as a JSON or XML rich input body part in the same multipart/form-data request. Alternately, you can choose to send that information in request parameters. If you pass both a rich input request body and request parameters, the request parameters are ignored. For information about how to create the multipart/form-data message, see Uploading Binary Files.

As of API version 29.0, feed items can contain 5000 characters. This change is backwards compatible; all earlier API versions support the 5000 character limit. In API versions 23.0 and 24.0, posts to the User Profile Feed Items resource created user status updates; they didn’t create feed items. Therefore, the character limit for the User Profile Feed Items resource for those API versions is still 1000 characters.

Resource

1/chatter/feeds/user-profile/me/feed-items

or

1/chatter/feeds/user-profile/userId/feed-items

Available versions

23.0–31.0

In version 32.0 and later, use User Profile Feed Elements.

Important

Requires Chatter

Yes

HTTP methods

GET, POST or HEAD

Request body for POST

Root XML tag

<feedItem>

JSON

The following example attaches a poll to a feed item:

1{
2   "body":{
3      "messageSegments":[
4         {
5            "type":"Text",
6            "text":"When should we meet for release planning?"
7         }
8      ]
9   },
10   "capabilities":{
11      "poll":{
12         "choices":[
13            "Monday",
14            "Tuesday"
15         ]
16      }
17   },
18   "feedElementType":"FeedItem",
19   "subjectId":"me"
20}

Feed items support more than one capability. The following example attaches a file to a feed item and bookmarks it.

1{
2   "body":{
3      "messageSegments":[
4         {
5            "type":"Text",
6            "text":"Check out the latest marketing collateral."
7         }
8      ]
9   },
10   "capabilities":{
11      "bookmarks":{
12         "isBookmarkedByCurrentUser": true
13      },
14      "content":{
15         "contentDocumentId": "069D00000001uQO"
16      }
17   },
18   "feedElementType":"FeedItem",
19   "subjectId":"me"
20}

Properties

Name	Type	Description	Required or Optional	Available Version
attachment	Depends on type.	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) As of API version 32.0, use the capabilities property. Important	Optional
body	Message Body Input	Description of message body. The body can contain up to 25 mentions. If you specify originalFeedItemId to share a feed item, use the body property to add a comment to the feed item. If this feed item is shared, this value is the body of the first comment.	Optional	23.0
capabilities	Feed Element Capabilities Input	The capabilities that define the behavior of this feed element.	Optional	31.0
isBookmarked​ByCurrentUser	Boolean	Specifies if the new feed item should be bookmarked for the user (true) or not (false). Default value is false. As of API version 32.0, use the capabilities.bookmarks.​isBookmarkedByCurrentUser property. Important	Optional	24.0–31.0
feedElementType	String	The type of feed element this input represents. The only valid value is FeedItem.	Required	31.0
originalFeedElementId	String	If this feed element is shared, this is the original feed element 18-character ID. This parameter takes precedence over all other parameters. For example, if you share a post and also try to upload a file, the generated feed-item only contains the shared post. You should only share a post or upload a file, not both in the same post. Note	Optional	31.0
originalFeedItemId	String	If this feed item is shared, this is the original feed item 18-character ID. As of API version 32.0, use the originalFeedElementId property. Important	Optional	24.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.	Required	31.0
visibility	String	Who can see the post. Valid values are: InternalUsers—If Communities is enabled, only members of the default, internal community can see the feed item. AllUsers—If Communities is enabled, all members of the community 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 or a Group, the visibility of the feed item must be AllUsers.	Optional	26.0

Request parameters for POST

Use one of the following sets of parameters. For example, you can’t post a link and attach a file in the same request.

Parameters for attaching an existing file

Parameter Name	Type	Description	Required or Optional	Available Version
attachmentType	String	The attachment type. Must contain the value ExistingContent.	Required	27.0–31.0
contentDocumentId	String	18-character ID of an existing file.	Required	23.0–31.0
isBookmarked​​ByCurrentUser	Boolean	Specifies if the new feed item should be bookmarked for the user (true) or not (false). Default value is false.	Optional	26.0–31.0
text	String	Text of the feed item.	Optional	23.0–31.0
visibility	String	Who can see the post. Valid values are: InternalUsers—If Communities is enabled, only members of the default, internal community can see the feed item. AllUsers—If Communities is enabled, all members of the community 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 or a Group, the visibility of the feed item must be AllUsers.	Optional	26.0–31.0

Parameters for attaching a new file

Parameter Name	Type	Description	Required or Optional	Available Version
attachmentType	String	The attachment type. Must contain the value NewFile.	Required	27.0–31.0
desc	String	Description of file being posted. This parameter should not be used as of version 27.0. Use description instead. Attention	Optional	23.0–26.0
description	String	Description of file being posted.	Optional	27.0–31.0
fileName	String	File name of the file being posted. This parameter should not be used as of version 24.0. Use title instead. Attention	Required	23.0–24.0
isBookmarked​​ByCurrentUser	Boolean	Specifies if the new feed item should be bookmarked for the user (true) or not (false). Default value is false.	Optional	26.0–31.0
text	String	Text of the feed item.	Optional	23.0–31.0
title	String	File name of a file to be uploaded and posted.	Required	24.0–31.0
visibility	String	Who can see the post. Valid values are: InternalUsers—If Communities is enabled, only members of the default, internal community can see the feed item. AllUsers—If Communities is enabled, all members of the community 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 or a Group, the visibility of the feed item must be AllUsers.	Optional	26.0–31.0

Parameters for posting a link

Parameter Name	Type	Description	Required or Optional	Available Version
attachmentType	String	The attachment type. Must contain the value Link.	Required	27.0–31.0
isBookmarked​​ByCurrentUser	Boolean	Specifies if the new feed item should be bookmarked for the user (true) or not (false). Default value is false.	Optional	26.0–31.0
text	String	Text of the feed item.	Optional	23.0–31.0
url	String	URL of the link.	Required	23.0–31.0
urlName	String	Name of the URL.	Optional	23.0–31.0
visibility	String	Who can see the post. Valid values are: InternalUsers—If Communities is enabled, only members of the default, internal community can see the feed item. AllUsers—If Communities is enabled, all members of the community 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 or a Group, the visibility of the feed item must be AllUsers.	Optional	26.0–31.0

Parameters for posting a poll

Parameter Name	Type	Description	Required or Optional	Available Version
attachmentType	String	The attachment type. Must contain the value Poll.	Required	27.0–31.0
isBookmarked​​ByCurrentUser	Boolean	Specifies if the new feed item should be bookmarked for the user (true) or not (false). Default value is false.	Optional	26.0–31.0
pollChoice1 through pollChoice10	String	The choices used to create a new feed item with a poll. You must specify 2–10 poll choices for each poll.	Required	26.0–31.0
text	String	Text of the feed item.	Required	23.0–31.0
visibility	String	Who can see the post. Valid values are: InternalUsers—If Communities is enabled, only members of the default, internal community can see the feed item. AllUsers—If Communities is enabled, all members of the community 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 or a Group, the visibility of the feed item must be AllUsers.	Optional	26.0–31.0

Parameters for sharing a post

Parameter Name	Type	Description	Required or Optional	Available Version
isBookmarked​ByCurrentUser	Boolean	Specifies if the new feed item should be bookmarked for the user (true) or not (false). Default value is false.	Optional	26.0–31.0
originalFeedItemId	String	The 18-character ID of the feed item you want to share. Sharing a post takes precedence over uploading a file. Do not share a post and upload a file in the same post. Note	Required	24.0–31.0
text	String	A comment on the shared feed item.	Optional	28.0–31.0
visibility	String	Who can see the post. Valid values are: InternalUsers—If Communities is enabled, only members of the default, internal community can see the feed item. AllUsers—If Communities is enabled, all members of the community 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 or a Group, the visibility of the feed item must be AllUsers.	Optional	26.0–31.0

Parameters for posting text only

Parameter Name	Type	Description	Required or Optional	Available Version
isBookmarked​​ByCurrentUser	Boolean	Specifies if the new feed item should be bookmarked for the user (true) or not (false). Default value is false.	Optional	26.0–31.0
text	String	Text of the feed item. The maximum number of characters is 1000.	Required	23.0–31.0
visibility	String	Who can see the post. Valid values are: InternalUsers—If Communities is enabled, only members of the default, internal community can see the feed item. AllUsers—If Communities is enabled, all members of the community 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 or a Group, the visibility of the feed item must be AllUsers.	Optional	26.0–31.0

Parameters for posting a canvas app

Parameter Name	Type	Description	Required or Optional	Available Version
attachmentType	String	The attachment type. Must contain the value Canvas.	Required	29.0–31.0
description	String	Description of the canvas app	Optional	29.0–31.0
developerName	String	The developer name (API name) of the canvas app	Required	29.0–31.0
height	String	The height of the canvas app in pixels. Default height is 200 pixels.	Optional	29.0–31.0
isBookmarked​​ByCurrentUser	Boolean	Specifies if the new feed item should be bookmarked for the user (true) or not (false). Default value is false.	Optional	29.0–31.0
namespacePrefix	String	The namespace prefix of the Developer Edition organization in which the canvas app was created.	Optional	29.0–31.0
parameters	String	Parameters passed to the canvas app in JSON format. The JSON must be URL-encoded: 1parameters={'isUpdated'='true';}"	Optional	29.0–31.0
text	String	Text of the feed item	Optional	29.0–31.0
thumbnailUrl	String	The URL to a thumbnail image for the canvas app. Maximum dimensions are 120x120 pixels.	Optional	29.0–31.0
title	String	The title of the link to the canvas app	Optional	29.0–31.0
visibility	String	Who can see the post. Valid values are: InternalUsers—If Communities is enabled, only members of the default, internal community can see the feed item. AllUsers—If Communities is enabled, all members of the community 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 or a Group, the visibility of the feed item must be AllUsers.	Optional	29.0–31.0

Request parameters for GET or HEAD

Parameter Name	Type	Description	Required or Optional	Available Version
density	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. FewerUpdates—Displays all updates from people and records the user follows and groups the user is a member of, but hides some system-generated updates from records. The default value is AllUpdates.	Optional	29.0–31.0
page	String	A generated token that indicates the view of feed items in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as nextPageURL, for example: 1"nextPageUrl": 2"/services/data/v32.0/ 3chatter/feeds/news/ 4005D0000001GLowIAN 5/feed-items 6?page=2011-03-30T17:34:50Z, 70D5D0000000DSv4KAG"	Optional	23.0–31.0
pageSize	Integer	Specifies the number of items per page. Valid values are between 1 and 100. If you don't specify a size, the default is 25.	Optional	23.0–31.0
q	String	One or more keywords to search for in the body and comments of feed items in this feed. The search string can contain wildcards and must contain at least two characters that aren’t wildcards. See Wildcards.	Optional	28.0–31.0
recentComment​Count	Integer	Maximum number of comments to include per feed item. The default value is 3. The maximum value is 25.	Optional	29.0–31.0
sort	String	Specifies the order returned by the sort, such as by date created or last modified: CreatedDateDesc—Sorts by most recent creation date. LastModifiedDateDesc—Sorts by most recent activity. The default value is CreatedDescDate.	Optional	23.0–31.0

Response body for GET

Feed Item Page

Response body for POST

Feed Item

This resource is deprecated as of version 26.0.

Returns a flat feed, that is, a feed where there is no hierarchy between feed items and comments: Feed items and comments are at the same level. All items are returned in chronological order.

Resource

1/chatter/feeds/user-profile/me/feed-items/flat

or

1/chatter/feeds/user-profile/userId/feed-items/flat

Available since version

25.0–26.0

Requires Chatter

Yes

HTTP methods

GET or HEAD

Request parameters

Parameter Name	Type	Description
numFeedItems	Integer	Specifies the number of feed items returned. Valid values are between 0 and 100. Default value is 25. Because feed items may include comments, specifying 25 flat feed items may actually return more. For example, if each feed item has one comment, and recentCommentCount is greater than 1, 50 flat feed items are returned.
page	String	A generated token that indicates the view of feed items in the feed. Page tokens are returned as part of the response body, in one of the URL parameters, such as nextPageURL.
recentComment​Count	Integer	Specifies the number of recent comments returned. Valid values are between 0 and 25. Default value is 3.
sort	String. One of the following: CreatedDateDesc LastModifiedDateDesc	Sorts the returned feed either by created date in ascending order, or by last modified date, also in ascending order. The default is LastModifiedDateDesc

Response body

Flat Feed