Chatter Feed Streams

Get or search a list of Chatter feed streams for the context user. Create a Chatter feed stream.

Resource

1/chatter/streams

1/connect/communities/communityId/chatter/streams

Available version

39.0

Requires Chatter

Yes

HTTP methods

GET, POST

Request parameters for GET

Parameter Name	Type	Description	Required or Optional	Available Version
`globalScope` (pilot)	Boolean	Specifies whether to get streams from all the context user’s communities, regardless of the `communityId` value. We provide the `globalScope` parameter to selected customers through a pilot program that requires agreement to specific terms and conditions. To be nominated to participate in the program, contact Salesforce. Pilot programs are subject to change, and we can’t guarantee acceptance. The `globalScope` parameter isn’t generally available unless or until Salesforce announces its general availability in documentation or in press releases or public statements. We can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features. Note If you know the community ID of the streams, we recommend using `/connect/communities/communityId/chatter/streams` and not using `globalScope`.	Optional	41.0
`page`	Integer	Specifies the number of the page you want returned. Starts at 0. If you pass in `null` or 0, the first page is returned.	Optional	39.0
`pageSize`	Integer	Specifies the number of items per page. Valid values are from 1 to 250. The default size is 25.	Optional	39.0
`q`	String	Specifies the string to search. The search string must contain at least two characters, not including wildcards. See Wildcards.	Optional	40.0
`sort`	String	Specifies the sort order. Values are: `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. If not specified, default value is `Ascending`.	Optional	40.0

Response body for GET

Chatter Stream Collection

Request body for POST

Root XML tag

<stream>

JSON example

1{
2   "description" : "Feeds from my management hierarchy.",
3   "name" : "Managers Stream",
4   "subscriptionsToAdd" : {
5      "subscriptions" : [
6         {"entityId" : "00590000000Dk5F"},
7         {"entityId" : "00590000000Fk4M"},
8         {"entityId" : "00590000000Sy7N"},
9         {"entityId" : "00590000000Dk4H"},
10         {"entityId" : "00590000000Uk7L"}
11         ]
12      }
13}

Properties

Name	Type	Description	Required or Optional	Available Version
`description`	String	Description of the stream, up to 1,000 characters.	Optional	39.0
`name`	String	Name of the stream, up to 120 characters.	Required when creating a stream (POST) Optional when updating a stream (PATCH)	39.0
`subscriptionsToAdd`	Stream Subscription Input[]	List of up to 25 entities whose feeds are included in the stream. Adding an entity that is already added results in no operation. Including the same entity in `subscriptionsToAdd` and `subscriptionsToRemove` results in no operation.	Optional	39.0
`subscriptionsToRemove`	Stream Subscription Input[]	List of entities whose feeds are removed from the stream. Removing an entity that is already removed results in no operation. Including the same entity in `subscriptionsToAdd` and `subscriptionsToRemove` results in no operation.	Optional when updating a stream (PATCH) Not supported when creating a stream (POST)	39.0

Request parameters for POST

Parameter Name	Type	Description	Required or Optional	Available Version
`description`	String	Description of the stream, up to 1,000 characters.	Optional	39.0
`name`	String	Name of the stream, up to 120 characters.	Required	39.0

Response body for POST

Chatter Stream

Chatter REST API Developer Guide

Chatter Feed Streams