Chatter Feed Stream

Get information about, update, or delete a Chatter feed stream.
Resource
1/chatter/streams/streamId
1/connect/communities/communityId/chatter/streams/streamId
Available version
39.0
Requires Chatter
Yes
HTTP methods
GET, PATCH, DELETE
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 stream, we recommend using /connect/communities/communityId​/chatter/streams/streamId and not using globalScope.
Optional 41.0
Response body for GET
Chatter Stream
Request body for PATCH
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
subscriptions​ToAdd 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
subscriptions​ToRemove 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 PATCH
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. Optional 39.0
Response body for PATCH
Chatter Stream
Response body for DELETE
204: Successful Delete