Chatter REST API Developer Guide

Chatter REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Request Bodies
Action Link Definition Input
Action Link Group Definition Input
Action Link Input
Action Link Template Binding Input
Activity Reminder Input
Alternative Input
Announcement Input
Article Topic Assignment Job Input
Asset File Input
Associated Actions Capability Input
Async Query Input
Attachment Input: Canvas App
Attachment Input: Existing Content
Attachment Input: Feed Poll
Attachment Input: Link
Attachment Input: New File Upload
Audience Criterion Input
Audience Input
Banner Photo Input
Batch Collection Input
Batch Input
Bookmarks Capability Input
Canvas Capability Input
Chatter Stream Input
Clean Input
Close Capability Input
Comment Input
Comment Capabilities Input
Community Input
Content Capability Input
Custom List Audience Criteria Input
Custom Recommendation Audience Input
Custom Recommendation Definition Input
Datacloud Contact Import Input
Datacloud Order Input
Dashboard Component Snapshot Input
Digest Job Input
Direct Message Capability Input
Duplicate Job Input
Duplicate Job Status Input
Environment Hub SSO User Mapping Input
Extension Input
Extensions Capability Input
Feed Element Capabilities Input
Feed Entity Share Capability Input
Feed Favorite Input
Feed Item Input
Feed Item Topic Input
Feed Poll Input
File Input
File ID Input
Files Capability Input
File Shares Input
Files Connect Field Value Input
Files Connect Item Input
Files Connect Permission Collection Input
Files Connect Permission Input
Folder Input
Folder Item Input
Following Input
Generic Batch Collection Input
Generic Batch Input
Group Chatter Settings Input
Group Information Input
Group Input
Group Member Input
Group Membership Request Update
Group Record Input
Invite Collection Input
Link Capability Input
List Current Share Collection Input
Managed Social Account Setup Input
Managed Topic Input
Managed Topic Position Collection Input
Managed Topic Position Input
Message Body Input
Message Segment Input: Entity Link
Message Segment Input: Hash Tag
Message Segment Input: Inline Image
Message Segment Input: Link
Message Segment Input: Markup Begin
Message Segment Input: Markup End
Message Segment Input: Mention
Message Segment Input: Text
Messaging Channel Input
Moderation Flag Input
Mute Capability Input
New User Audience Criteria Input
Next Best Action Strategy Input
Notification App Setting Input
Notification Member Input
Notification Setting Input
Photo Input
Pin Capability Input
Poll Capability Input
Push Notification Input
Question and Answers Capability Input
Read By Capability Input
Recommendation Reaction Input
Record Capability Input
Request Header Input
Scheduled Custom Recommendation Input
Share Captured Activity Input
Share Input
Social Customer Service Configuration Input
Social Customer Service Message Type Settings Input
Social Customer Service Provider Settings Input
Social Post Mass Approval Input
Status Capability Input
Stream Subscription Input
Target Collection Input
Target Collection Update Input
Target Input
Target Update Input
Topic Assignment Input
Topic Endorsement Input
Topic Input
Topic Names Input
Topics Capability Input
Up Down Vote Capability Input
User Chatter Settings Input
User ID Collection Input
User Input
User Message
User Message Recipient Input
User Message Recipient List Input
User Mission Activity Input
User Status Input
User Stream (Conversation) Input
Verified Capability Input
Response Bodies
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

Chatter Stream Input

A Chatter feed stream.
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