Database.com Chatter REST API Developer's Guide - Salesforce.com

Version 27.0: Spring ’13
Database.com Chatter REST API Developer's
Guide
Last updated: May 3, 2013
© Copyright 2000–2013 salesforce.com, inc. All rights reserved. Salesforce.com is a registered trademark of salesforce.com, inc., as are other
names and marks. Other marks appearing herein may be trademarks of their respective owners.

Table of Contents
Table of Contents
Chatter API.........................................................................................................................................1
Chapter 1: Introducing Chatter REST API..................................................................................1
Deciding When to Use Chatter API.............................................................................................................................2
Understanding Chatter API Resources.........................................................................................................................2
Building the Chatter API Resource URL.........................................................................................................7
Using Chatter API Inputs.................................................................................................................................8
Using Wildcards..............................................................................................................................................12
Send HTTP Requests with cURL..............................................................................................................................13
Understanding OAuth and Chatter API.....................................................................................................................13
Understanding the Web Server OAuth Authentication Flow.........................................................................15
Understanding the User-Agent OAuth Authentication Flow.........................................................................19
Using Tokens...................................................................................................................................................21
Requesting Static Assets and Posting Forms Directly from HTML...............................................................22
Chapter 2: Quick Start...............................................................................................................24
Prerequisites.................................................................................................................................................................25
Step One: Set Up Authorization.................................................................................................................................25
Step Two: Connect to Chatter API Using OAuth.....................................................................................................26
Chapter 3: Chatter API: How do I. . ..........................................................................................28
Chapter 4: Chatter API Resources..............................................................................................40
Chatter API Resources Relationships.........................................................................................................................44
Bookmarks Resources..................................................................................................................................................47
Chatter Resource.........................................................................................................................................................52
Comments Resources..................................................................................................................................................53
Company Feed Resources............................................................................................................................................56
Connect Resources......................................................................................................................................................58
Favorites Feed Resources.............................................................................................................................................60
Feeds Resource............................................................................................................................................................65
Feed-Items Resources..................................................................................................................................................67
Feed-Items Query............................................................................................................................................68
Feed-Items, Specific Feed Item.......................................................................................................................69
Feed-Items Comments....................................................................................................................................73
Feed-Items Likes.............................................................................................................................................77
Feed-Items Polls..............................................................................................................................................78
Files Resources............................................................................................................................................................79
Files Feed Resources....................................................................................................................................................86
Filter Feed Resources..................................................................................................................................................90
Groups Feed Resources...............................................................................................................................................94
Group-Memberships Resources..................................................................................................................................97
i

Table of Contents
Groups Resources......................................................................................................................................................101
List of Groups................................................................................................................................................101
Group Information........................................................................................................................................103
Batch Group Information..............................................................................................................................105
Group Files....................................................................................................................................................105
Group Members............................................................................................................................................107
Group Members—Private.............................................................................................................................110
Group Membership Requests—Private.........................................................................................................113
Group Photo..................................................................................................................................................114
Group Settings...............................................................................................................................................116
Influence Resource.....................................................................................................................................................117
Likes Resource...........................................................................................................................................................118
Motifs Resources.......................................................................................................................................................119
News Feed Resources................................................................................................................................................120
People Feed Resources..............................................................................................................................................134
Record Feed Resource...............................................................................................................................................138
Records Resources.....................................................................................................................................................154
Subscriptions Resource..............................................................................................................................................156
To Feed Resources....................................................................................................................................................157
Topics Resource.........................................................................................................................................................160
User-Profile Feed Resources......................................................................................................................................161
Users Resources.........................................................................................................................................................170
User Information...........................................................................................................................................172
User Profile Information................................................................................................................................173
Batch User Information.................................................................................................................................174
User Conversations, General.........................................................................................................................174
User Conversations, Specific..........................................................................................................................176
Change Status of Conversations....................................................................................................................177
Get Unread Count for Conversations............................................................................................................178
Users Files, General.......................................................................................................................................178
User Files, Filtered by Group........................................................................................................................181
User Files, Filtered by Sharing.......................................................................................................................182
User Followers...............................................................................................................................................183
Following Users.............................................................................................................................................184
User Groups...................................................................................................................................................186
User Messages, General.................................................................................................................................186
User Messages, Specific.................................................................................................................................192
User Photo.....................................................................................................................................................193
User Recommendations, General..................................................................................................................194
User Recommendations for a Specific Action...............................................................................................197
User Recommendations for a Specific Action and Object Category.............................................................197
User Recommendations for a Specific Action and Key Prefix.......................................................................199
User Recommendations for a Specific Action and Object ID.......................................................................200
User Settings..................................................................................................................................................201
User Status.....................................................................................................................................................203
ii

Table of Contents
Chapter 5: Chatter API Request Bodies....................................................................................205
Chapter 6: Chatter API Resource Returns................................................................................219
Response Bodies........................................................................................................................................................219
Response Body Filters...............................................................................................................................................258
Response Body Encoding..........................................................................................................................................262
Status Codes and Error Responses............................................................................................................................263
Connect in Apex...............................................................................................................................265
Chapter 7: Getting Started with Connect in Apex......................................................................265
When Should You Use Apex?...................................................................................................................................266
Understanding Connect in Apex...............................................................................................................................266
Primary Differences Between Chatter REST API and Connect in Apex.................................................................267
Testing Connect in Apex...........................................................................................................................................271
Map Relating Chatter API Resources to Apex Methods .........................................................................................272
Chapter 8: Connect in Apex API Reference..............................................................................280
Chatter Class.............................................................................................................................................................281
ChatterFavorites Class...............................................................................................................................................282
ChatterFeeds Class....................................................................................................................................................284
ChatterGroups Class.................................................................................................................................................308
ChatterUsers Class....................................................................................................................................................314
Records Class.............................................................................................................................................................322
Input Classes.............................................................................................................................................................322
Output Classes...........................................................................................................................................................326
Enums ......................................................................................................................................................................351
Exceptions.................................................................................................................................................................354
Index...............................................................................................................................................355
iii

Table of Contents
iv

CHATTER API
Chapter 1
Introducing Chatter REST API
In this chapter ...
Chatter API is a REST API that provides programmatic access to Chatter feeds
and social data such as users, groups, followers, and files. It's used by developers
• Deciding When to Use Chatter API who want to integrate Chatter into a variety of applications such as mobile
•
•
Understanding Chatter API
Resources
Send HTTP Requests with cURL
applications, intranet sites, and third-party Web applications. Chatter API is
similar to APIs offered by other companies with feeds, such as Facebook and
Twitter. Its advantages include ease of integration and development.
• Understanding OAuth and Chatter
API
Note: Chatter API and Chatter REST API refer to the same API.
To use this documentation, you should have a basic familiarity with software
development, Web services, OAuth, and Chatter.
The following sections include:
• The key characteristics and architecture of Chatter REST API. This will
help you understand how your applications can best use Chatter API resources.
• How to set up your development environment so you can start working with
Chatter API.
• How to configure OAuth for your client application.
• A tutorial that leads you step by step through a typical use case.
1

Introducing Chatter REST API
Deciding When to Use Chatter API
Deciding When to Use Chatter API
Use Chatter API to:
• Build a mobile client that displays a Chatter feed.
• Integrate a third-party Web application with Chatter so it can notify groups of users about events.
• Display the Chatter feed on an external system, such as an intranet site, after users are authenticated.
• Make feeds actionable and integrated with third-party sites. For example, an app that posts a Chatter item to Twitter
whenever the post includes #tweet hashtag.
• Create simple games that interact with the feed for notifications. Games might include things like sales incentive
competitions.
• Creating a custom, branded skin for Chatter for your organization.
How is Chatter API Different from other APIs?
Chatter API complements the SOAP API by making it easy to interact with Chatter data, such as feeds, group information,
and Chatter user-profile details.
The following are some of the differences between Chatter API and the SOAP API:
• Returned information is automatically localized to the user's time zone and language.
• Feed items are structured in a way that makes it easy to render on Web sites and mobile devices.
• Changed values that are tracked in a feed are returned as value-pair representations.
• Relationships between objects can easily be traversed without having to resolve foreign keys. For example, using Chatter
API you can get all of a user's followers or groups with one request per page.
Selecting the Right API for Your Application
Database.com provides many types of APIs for various use cases, including both SOAP API and REST API. These APIs
provide access to the majority of Database.com data, including most of the Chatter data.
So when should you use which API?
Situations where you would want to use SOAP API or REST API include:
• Migrating or synchronizing user profiles and their associated user photos from one system to another.
• Creating analytic applications for Chatter.
• Queries where you want to select specifically which records or fields are returned.
SOAP API and REST API’s rate limiting and powerful query language more suited to these use cases and contains most of
the applicable Chatter data.
However, Chatter API is the only API that supports some of Chatter’s more complex data structures, for example posting
photos or using @mention rich text in feed items. If necessary, you can use SOAP API or REST API for the bulk of your
queries, then use the feed item or comment Ids you’ve extracted to selectively work with Chatter API.
Understanding Chatter API Resources
In general, the process flow for using Chatter API is as follows:
1. Send an HTTP request to Database.com.
2

Introducing Chatter REST API
Understanding Chatter API Resources
2. The system authenticates the user and client app.
3. Request Chatter API resources using an HTTP request.
4. The system returns an HTTP return code. Additional information (such as a Chatter API response body) is optionally
included in the response.
Each resource in Chatter API is a URI used with an HTTP method (such as GET, POST, DELETE, or HEAD). Each
resource represents something in Chatter, such as a user's news feed, or the comments on a post.
Many of the resources use either a specified userId or the keyword me to indicate the current, logged-in user. For example, to
return the user-profile information for the current, logged-in user, use the following resource:
/chatter/users/me
You could also specify a particular user by user Id:
/chatter/users/005D0000001GLoh
When you successfully access a resource, a response body is returned in JSON or XML. By default, JSON is returned. Each
response body may contain one or more response bodies. For example, the following is the response body of the above resource
(users). Note that it includes other response bodies as well, such as address, current status, and phone numbers:
Property
Type
Description
Since Version
aboutMe
String
Text from user's profile
23.0
address
Address
Address
23.0
chatterActivity
Chatter Activity
Chatter activity statistics
23.0
chatterInfluence
Chatter Influence
User’s influence rank
23.0
companyName
String
Company name
23.0
currentStatus
User Status
Note: This property is no longer available
as of version 25.0.
23.0–25.0
User's current status
email
String
User's email address
23.0
firstName
String
User's first name
23.0
followersCount
Integer
Number of users following this user
23.0
followingCounts
Following Counts
Information about items the user is following
23.0
groupCount
Integer
Number of groups user is following
23.0
id
String
18-character Id of the user
23.0
isActive
Boolean
true if user is active, false otherwise
23.0
isChatterGuest
Boolean
Note: This property is no longer available
as of version 26.0. Use the userType
property instead.
23.0–25.0
3

Introducing Chatter REST API
Understanding Chatter API Resources
Property
Type
Description
Since Version
true if user is a Chatter customer, false otherwise
lastName
String
User's last name
23.0
managerId
String
18-character Id of the user’s manager
23.0
managerName
String
Locale-based concatenation of manager's first and
last names
23.0
motif
Motif
Small, medium, and large icons indicating that the
object is a user:
27.0
"motif": {
"largeIconUrl":
"/img/icon/profile64.png",
"mediumIconUrl":
"/img/icon/profile32.png",
"smallIconUrl":
"/img/icon/profile16.png"
}
The motif icon is not the user’s profile picture.
mySubscription
Reference
If the logged-in user is following this user, this
contains information about the subscription, else
returns null
23.0
name
String
Locale-based concatenation of user's first and last
names
23.0
phoneNumbers
Phone Number[]
Collection of user's phone numbers
23.0
photo
Photo
Information about the user's photos
23.0
title
String
Title of the user
23.0
type
String
User
23.0
url
String
URL to the user's profile
23.0
username
String
User name of the user, such as
Admin@mycompany.com.
24.0
userType
String
Type of user. Values are:
• ChatterGuest—User is a Chatter customer in
an external group
• Guest—Unauthenticated users
• Internal—User is a standard organization
member
• Portal—User is a Customer Portal User, a
communities user, and so on.
• System—User is Chatter Expert or a system
user
26.0
4

Introducing Chatter REST API
Understanding Chatter API Resources
In JSON format, the output is as follows:
{
"aboutMe": "I'm excited to be part of the team focused on building out our apps
business
and showing our customers their future.",
"address": {
"city": "Seattle",
"country": "US",
"state": "WA",
"street": "2001 8th Ave",
"zip": "98121"
"formattedAdress": "2001 8th Ave\nSeattle, WA 98121\nUS"
},
"chatterActivity": {
"commentCount": 0,
"commentReceivedCount": 1,
"likeReceivedCount": 0,
"postCount": 2
},
"companyName": "Seattle Apps",
"email": "mraven@seattleapps.com",
"firstName": "Marion",
"followersCount": 1,
"followingCounts": {
"people": 5,
"records": 0,
"total": 5
},
"groupCount": 3,
"id": "005D0000001Kl6xIAC",
"isActive": true,
"lastName": "Raven",
"managerId": null,
"managerName": null,
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Marion Raven",
"phoneNumbers": [{
"number": "(206) 999-2846",
"type": "Work"
}],
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1i9x6Z16L8wXEGigpcWjAd",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1q43x_rW2ciXBHst0Eh3Y6",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001Kl6xIAC",
"userType": "Internal";
"username": "mraven@seattleapps.com"
5

Introducing Chatter REST API
Understanding Chatter API Resources
Note: Database.com runs on multiple server instances. The examples in this guide use instance_name to indicate
the instance. The instance for your organization may be similar to na3.database.com or na6.mycompany.com.
Some of the items in a response body have a fully qualified URL, however, most of the returned URLs are relative.
If the URL is relative, prepend it with the instance given to the client app when the item is authenticated.
The following are important characteristics of Chatter API resources and architecture:
Stateless
Each request from client to server must contain all the information necessary to understand the request, and not use any
stored context on the server. However, the representations of the resources are interconnected using URLs, which allow
the client to progress between states.
Uniform interface
All resources are accessed with a generic interface over HTTP.
Authentication
Chatter API uses OAuth 2.0.
Support for JSON and XML
The JavaScript Object Notation (JSON) format is supported with UTF-8. Date-time information is in ISO8601 format.
XML serialization is similar to SOAP API. XML requests are supported in UTF-8 and UTF-16, and XML responses
are provided in UTF-8.
Responses are in JSON format by default. To specify XML, use the HTTP header Accept: application/xml.
(To specify JSON, use Accept: application/json.)
You can append either .json or .xml to the URI of any resource to specify how the return is formatted. For example,
/chatter/feeds/filter/me/001/feed-items.xml.
Support for Method Overriding
If you use an HTTP library that doesn’t allow overriding or setting an arbitrary HTTP method name, you can send a
POST request and provide an override to the HTTP method with the request parameter _HttpMethod. For example:
https://instance_name/services/data/v27.0/chatter/
/chatter/users/me/conversations/03MD0000000008KMAQ
?_HttpMethod=PATCH&read=true
Note: The _HttpMethod parameter is case sensitive. Be sure to use the correct case for all values.
Localized names and times
Chatter API localizes both the names and datetimes to the language and time zone settings of the current user. This
means mobile devices don't need their own language or time zone settings. Users set their locale in their personal
information.
Chatter API Request Limits
Chatter API requests are subject to rate limiting. Chatter API has a per user, per application, per hour rate limit. When
you exceed the rate limit, all Chatter API resources return a 503 Service Unavailable error code for both the user and
6

Introducing Chatter REST API
Building the Chatter API Resource URL
application. When polling for feed updates or private messages, use the /feeds/news/me |userId/is-modified
endpoint and do not exceed one poll per minute.
Note: Though the Is-Modified resource is generally available, your organization may not have permission to
use it automatically. If you can’t access this resource, contact your salesforce.com representative and ask about
the “Enabled Chatter Feed Polling” permission.
If an application uses a regular session ID for authentication instead of an OAuth token, that application's requests count
against a general allocation of requests where there is no associated OAuth consumer key. However, any other application
the user accesses, that is also authenticating with session IDs, is contending for the same allocation of requests . For
example, your app connects a user to Database.com using a regular session ID. This user now has the same number of
requests regardless of the app they are using. They no longer have a separate request limit per application: all applications
are now using the same limit. Because of this, we recommend clients use OAuth tokens whenever feasible.
Note: Stated limits aren't a promise that the specified resource is available at its limit in all circumstances. For
example, load, performance and other system issues might prevent some limits from being reached. The stated
limit may change without notice. Applications should make efficient use of available requests and gracefully
handle the 503 error code.
Default HTML Entity Encoding
Chatter API strings are minimally HTML entity encoded by default, which is suitable in most cases for display between
HTML tags, but not necessarily in other HTML contexts.
For non-HTML contexts, such as native mobile applications, Chatter API clients may request raw (unencoded) output
by setting the X-Chatter-Entity-Encoding HTTP header in your request to false.
For more information, see Response Body Encoding on page 262.
Feed Item Templates
Feed item templates make feed items easier to render by defining their layout. The Feed Item Attachment: Basic Template
is currently used for feed items that announce the creation of a group (the CollaborationGroupCreated feed item
type). However, Salesforce may reflect other events in the Basic Template in the future.
Building the Chatter API Resource URL
Note: Communities are available as a pilot program. Contact your salesforce.com representative to find out if your
organization qualifies for the community pilot.
Access all Chatter API resources by using the URI for your company's instance, combined with version information, and the
URI for the resource.
For example, building a URL, if your instance is:
https://na1.database.com/
And the version information is:
/services/data/v27.0/
7

Introducing Chatter REST API
Using Chatter API Inputs
And the resource is :
chatter/feeds/news/me/feed-items
Put together, the full URL is:
https://na1.database.com/services/data/v27.0/chatter/
feeds/news/me/feed-items
You can use the internal shortcut even if communities are not enabled. You may want do this if you’re developing an
application for multiple organizations and not all of them use communities.
The response bodies include URLs with /connect/communities/internal. This format enables you to perform string
interpolation when referencing communities.
Using Chatter API Inputs
Using POST, PATCH, or PUT for Input
When you make a request using the HTTP POST, PATCH, and PUT methods, you can use request parameters or a request
body. The request body can contain JSON or XML. If you pass request parameters and a request body, the request parameters
are usually ignored. However, if you pass both a request body and a text parameter, you’ll receive a 400 error.
To submit a request using request parameters, use a Content-Type header field with the value
application/x-www-form-urlencoded.
To submit a request using a request body, use one of the following values in a Content-Type header field and in an Accept
header field:
• application/json
• application/xml
Uploading Binary Files
The following table lists the resources that support binary file uploads:
Description
Uploads a file to a new post in the news
feed.
Uploads a file to a new post in the user
profile feed.
Uploads a file to a new post in the record
feed.
Uploads a file to a new comment.
Uploads a user photo.
Uploads a group photo.
Uploads a file to the Files tab.
Resource
/chatter/feeds/news/userId/feed-items
/chatter/feeds/user-profile/userId/feed-items
/chatter/feeds/record/recordId/feed-items
/chatter/feed-items/feedItemId/comments
/chatter/users/userId/photo
/chatter/groups/groupId/photo
/chatter/users/userId/files/
8

Introducing Chatter REST API
Using Chatter API Inputs
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.
To create a multipart/form-data request, in the head of the request, set the Content-Type HTTP header to
multipart/form-data.
For information about additional HTTP headers, see W3C Form content types, and RFC 2388, which defines the
multipart/form-data internet media type.
The following table describes the HTTP headers and parameters required in the rich input body part of a multipart/form-data
request:
HTTP Headers for Rich
Input Body Part
Content-Disposition
Content-Type
Header Value and Parameters
form-data; name="json"
form-data; name="xml"
application/json; charset=UTF-8
application/xml; charset=UTF-8
Description
The request body for a post or comment.
For JSON, the value of name must be "json".
For XML, the value of name must be "xml".
The data format and character set of the request
body.
For JSON, the value must be
application/json.
For XML, the value must be
application/xml.
The following table describes the HTTP headers and parameters required in the binary upload body part of a multipart/form-data
request:
HTTP Headers for Binary
Upload Body Part
Content-Disposition
Header Value and Parameters
form-data;
name="feedItemFileUpload";
filename=string
form-data; name="fileUpload"
filename=string
form-data; name="fileData"
filename=string
Description
To upload a binary file to a post or comment,
the value of name must be
"feedItemFileUpload".
To upload a user or group photo, the value of
name must be "fileUpload".
To upload a file to the File list, the value of name
must be "fileData".
Note: You must specify a filename
parameter and value. However, please
note that Chatter uses the value of the
Attachment Input: New File Upload
title property as the file name, not
the value of the filename parameter.
9

Introducing Chatter REST API
Using Chatter API Inputs
HTTP Headers for Binary
Upload Body Part
Content-Type
Header Value and Parameters
application/octet-stream;
charset=ISO-8859-1
Description
The media type and character set of the binary
file.
The following example posts a new feed item, uploads a binary file, and attaches it to the new feed item. The multipart request
in this example includes a part for the request body that has a Content-Type of application/json.
POST /services/data/v27.0/chatter/feeds/user-profile/005x0000001T9PwAAK/feed-items HTTP/1.1
Authorization: OAuth 00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA.
OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae
User-Agent: Jakarta Commons-HttpClient/3.0.1
Host: instance_name
Content-Length: 845
Content-Type: multipart/form-data; boundary=a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Accept: application/json
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="json"
Content-Type: application/json; charset=UTF-8
{ "body":
{
"messageSegments" : [
{
"type" : "Text",
"text" : "High priority content "
}, {
"type" : "Hashtag",
"tag" : "important"
}, {
"type" : "Text",
"text" : "Please review this as soon as possible."
}
]
},
"attachment":
{
"attachmentType" : "NewFile",
"description": "Quarterly review",
"title" : "2012_q1"
}
}
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="feedItemFileUpload"; filename="foo"
Content-Type: application/octet-stream; charset=ISO-8859-1
This is the content of the file.
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq--
The following is the same example using XML instead of JSON:
POST /services/data/v27.0/chatter/feeds/user-profile/005x0000001TBMVAA4/feed-items HTTP/1.1
Authorization: OAuth 00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA.
OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae
User-Agent: Jakarta Commons-HttpClient/3.0.1
Host: instance_name
Content-Length: 897
Content-Type: multipart/form-data; boundary=0HWq8x4y4DSQ4fqjXt6MinVMyqbf1r
Accept: application/xml
10

Introducing Chatter REST API
Using Chatter API Inputs
--0HWq8x4y4DSQ4fqjXt6MinVMyqbf1r
Content-Disposition: form-data; name="xml"
Content-Type: application/xml; charset=UTF-8
High priority content
Text
important
Hashtag
Please review this as soon as possible
Text
Quarterly review 2012 Q1
2012_q1
--0HWq8x4y4DSQ4fqjXt6MinVMyqbf1r
Content-Disposition: form-data; name="feedItemFileUpload"; filename="foo"
Content-Type: application/octet-stream; charset=ISO-8859-1
This is the content of the file.
--0HWq8x4y4DSQ4fqjXt6MinVMyqbf1r--
The following example posts a comment to a feed item and uploads a binary attachment:
POST /services/data/v27.0/chatter/feed-items/0D5x00000000RryCAE/comments HTTP/1.1
Authorization: OAuth 00DD0000000Jhd2!AQIAQC.lh4qTQcBhOPm4TZom5IaOOZLVPVK4wI_rPYJvmE8r2VW8XA.
OZ7S29JEM_7Ctq1lst2dzoV.owisJc0KacUbDxyae
Accept: application/json
User-Agent: Jakarta Commons-HttpClient/3.0.1
Host: instance_name
Content-Length: 978
Content-Type: multipart/form-data; boundary=F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI
--F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI
Content-Disposition: form-data; name="json"
Content-Type: application/json; charset=UTF-8
{ "body":
{
"messageSegments" : [
{
"type" : "Text",
"text" : "Here's another file for review."
}, {
"type" : "Hashtag",
"tag" : "important"
}, {
"type" : "Text",
"text" : "Again, please review this as soon as possible."
}
]
},
"attachment":
11

Introducing Chatter REST API
Using Wildcards
}
{
}
"attachmentType" : "NewFile",
"description": "Quarterly review 2012 Q2",
"title" : "2012_q2"
--F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI
Content-Disposition: form-data; name="feedItemFileUpload"; filename="foo"
Content-Type: application/octet-stream; charset=ISO-8859-1
This is the content of the file.
--F9jBDELnfBLAVmLNbnLIYibT5Icp0h3VJ7mkI--
Note: Spacing and carriage returns and line feeds (CRLF) are important. For example, the following line requires
spaces: Content-Disposition: form-data; name="feedItemFileUpload";
title="2012_q1_review.ppt" If you had used CRLF instead of spaces, you would have received an error.
Using Wildcards
Some of the resource request parameters support wildcards.
You can specify the following wildcard characters to match text patterns in your search:
Wildcard
*
?
Description
Asterisks match zero or more characters at the middle or end (not the beginning) of your search term. For
example, a search for john* finds items that start with john, such as, john, johnson, or johnny. A search for
mi* meyers finds items with mike meyers or michael meyers. If you are searching for a literal asterisk in a
word or phrase, then escape the asterisk (precede it with the \ character).
Question marks match only one character in the middle or end (not the beginning) of your search term.
For example, a search for jo?n finds items with the term john or joan but not jon or johan.
When using wildcards, consider the following issues:
• Wildcards take on the type of the preceding character. For example, aa*a matches aaaa and aabcda, but not aa2a or aa.!//a,
and p?n matches pin and pan, but not p1n or p!n. Likewise, 1?3 matches 123 and 143, but not 1a3 or 1b3.
• A wildcard (*) is appended at the end of single characters in Chinese, Japanese, Korean, and Thai (CJKT) searches, except
in exact phrase searches.
• The more focused your wildcard search, the faster the search results are returned, and the more likely the results will reflect
your intention. For example, to search for all occurrences of the word prospect (or prospects, the plural form), it is
more efficient to specify prospect* in the search string than to specify a less restrictive wildcard search (such as prosp*)
that could return extraneous matches (such as prosperity).
• Tailor your searches to find all variations of a word. For example, to find property and properties, you would specify
propert*.
• Punctuation is indexed. To find * or ? inside a phrase, you must enclose your search string in quotation marks and you
must escape the special character. For example, "where are you\?" finds the phrase where are you?. The escape
character (\) is required in order for this search to work correctly.
12

Introducing Chatter REST API
Send HTTP Requests with cURL
Send HTTP Requests with cURL
Chatter API uses HTTP methods to send and receive JSON and XML content, so it is very simple to build client applications
using the tool or the language of your choice. We recommend a command-line tool called cURL to simplify sending and
receiving HTTP requests and responses.
cURL is pre-installed on many Linux and Mac systems. Windows users can download a version at curl.haxx.se/. When
using HTTPS on Windows, ensure that your system meets the cURL requirements for SSL.
Your HTTP requests to a Chatter API resource should contain the following information:
• An HTTP method (such as HEAD, GET, POST, or DELETE).
• An OAuth 2.0 access token used to authenticate the request. For information on how to retrieve the token, see Step One:
Set Up Authorization on page 25.
• The Chatter API resource URL.
• Any JSON or XML files containing information needed for requests, such as updating a record with new information.
The HTTP methods are used to indicate the desired action, such as retrieving information, as well as creating, updating, and
deleting records.
• GET is used to retrieve information, such as basic resource summary information.
• POST is used to create a new Chatter API item, such as a comment or like, or subscribe to a group.
• PATCH is used for partial updates to an item, for example, renaming a file.
• PUT is used for whole updates to an item, for example, marking a conversation as read.
• DELETE is used to delete a Chatter API item, such as a feed-item, or unsubscribe from a group.
• HEAD is used to retrieve resource metadata. It's similar to using GET but without the response body. You can use HEAD
for testing the availability of a resource.
To access a resource, submit an HTTP request containing a header, method, and resource URL.
Understanding OAuth and Chatter API
OAuth is an open protocol that allows secure authentication for access to a user's data, without handing out the user's username
and password. It is often described as the valet key of software access: a valet key only allows access to certain features of your
car: for example, you can’t open the trunk or glove compartment using a valet key.
Chatter API uses OAuth to securely identify your application before connecting to Database.com.
When you use OAuth, you can avoid storing login credentials in your application. Instead, your application can prompt the
user to login using a standard Database.com page, which returns an access token to your application. Your application can use
this access token to access Chatter API Web services. This approach to authentication can be used in both mobile apps and
from a Web page.
Chatter API uses OAuth 2.0..
Understanding Connected Apps
To use Chatter API, you must create a REST entry point in your organization. Database.com defines this entry point as a
Connected App definition.
13

Introducing Chatter REST API
Understanding OAuth and Chatter API
For an example in creating a Connected App definition, see Step One: Set Up Authorization on page 25.
Considerations when creating and using a Connected App:
• The following maps the labels used in the Connected App definition to OAuth terms:
Connected App Label
Consumer Key
Consumer Secret
Callback URL
OAuth Term
client_id
client_secret
redirect_uri
Description
A unique identifier that identifies your
application to Database.com.
A secret key associated with your
application.
A URL associated with your client
application. In some contexts, this must
be a real URL that the client’s Web
browser is redirected to. In others, the
URL isn’t used; however, between your
client application and the server (the
Connected App definition) the value
must be the same. For example, you
may want to use a value that identifies
the application, such as
http://mycomponent.myapp.
• If you are developing a mobile app, you can use the following value for the Callback URL (redirect_uri) to avoid
setting up an application server of your own:
https://login.instance_name/services/oauth2/success
This value should NOT be used when developing a Web application.
• Your Connected App does not have to reside in the same organization as your users. The Connected App you create can
be used to sign into any organization.
• We recommend creating more than one Connected App definition: one for testing and one for production. If you create
only one, you must change the value of the Callback URL to reflect the location of your application code. In addition,
you should create more than one Connected App if you are developing for different platforms, such as iOS and Android.
OAuth Basics
• OAuth grants access by client applications to resources owned by resource owners. In terms of OAuth, a resource is anything
that must be kept secured. For Chatter API, the resource we are concerned about protecting is all the data accessible
through the API.
• It is up to a resource owner to grant access to resources. In our context, the resource owner is a combination of the
administrator (who administers users and the connected app) and the users (who log in and grant access to third party
applications).
• When an application wants to access a resource, it requests authorization from the resource owner. OAuth outlines various
ways that an application can be granted access to a resource. These are referred to as grant types or flows. Different flows
are suitable for different contexts.
• Once a client application has been authorized to access to a resource, the client application is given an access token and a
refresh token. The access token must be included by the authorized client application in any subsequent Web service
requests to identify itself. Access tokens have a limited lifetime. When an access token expires, the authorized client
application can make a special request using the refresh token to obtain a new access token.
14

Introducing Chatter REST API
Understanding the Web Server OAuth Authentication Flow
OAuth Flows
A user must be authenticated before accessing Database.com. OAuth has multiple authentication flows. There are several
steps in each authentication flow, as dictated by the OAuth standard and the type of application trying to access Database.com.
On successful authorization, the client application is provided with access and refresh tokens.
Database.com supports the following flows for use with the Chatter API:
• Web server flow
• User-agent flow
In addition, you can also use the refresh token to get a new access token after your application has been authorized for access.
Revoking Access
After a user has granted access to a client application, they can revoke access by clicking My Personal Information > Personal
Information, then in the Remote Access related section, clicking Revoke.
Understanding the Web Server OAuth Authentication Flow
Typically this flow is used by web applications that can confidentially store the client secret. A critical aspect of the Web server
flow is that the application must be able to protect the consumer secret.
The following is the general flow. The individual step descriptions follow.
15

Introducing Chatter REST API
Understanding the Web Server OAuth Authentication Flow
The following is a general description of the OAuth web-server flow:
1. To request authorization for a resource, the client application redirects the end-user’s browser to a web page hosted on the
resource owner’s authorization server. In this case, it is the Database.com log in page.
2. The end-user logs into Database.com to authenticate themselves. Since this web page is hosted by the resource owner
(Database.com) and interacted with directly by the end user, the client web application never finds out the user’s login
credentials. The end-user also grants authorization to the client application.
3. Database.com sends the authorization code back to the client application using the specified callback URL.
4. After obtaining the authorization code, the client application passes back the authorization code to obtain an access token.
5. After validating the authorization code, Database.com passes back a response token. If there was no error, the response
token includes an access code, a refresh token, and additional information.
6. The protected resources are Chatter API endpoints.
Using the Web Server Flow with Chatter API and Database.com
The following provides specific details for the OAuth Web-server flow when used with Database.com and Chatter API:
1. Direct the client’s web browser to the page https://login.instance_name/services/oauth2/authorize, with
the following request parameters:
16

Introducing Chatter REST API
Understanding the Web Server OAuth Authentication Flow
Parameter
response_type
client_id
redirect_url
Description
Must be code for this authentication flow
The Consumer Key value from the remote access
application defined for this application
The Callback URL value from the remote access
application defined for this application
You can also include the following optional request parameters:
Parameter
state
immediate
display
Description
Specifies URL-encoded state data to be returned in the
callback URL after approval.
Determines whether the user should be prompted for login
and approval. Values are either true or false. Default is
false.
• If set to true, and if the user is currently logged in and
has previously approved the application, the approval
step is skipped.
• If set to true and the user is not logged in or has not
previously approved the application, the session is
immediately terminated with the
immediate_unsuccessful error code.
Indicates the type of web pages that is provided. Valid values
are:
• page—Full-page authorization screen. This is the default
value if none is specified.
• popup—Compact dialog optimized for modern web
browser popup windows.
• touch—mobile-optimized dialog designed for modern
smartphones such as Android and iPhone.
• mobile—mobile optimized dialog designed for less
capable smartphones such as BlackBerry OS 5.
2. After successfully being logged in, the user is asked to authorize the application. Note that if the user has already authorized
the application, this step is skipped.
3. Once Database.com has confirmed that the client application is authorized, the end-user’s web browser is redirected to
the callback URL specified by the redirect_url parameter, appended with the following values in its query string:
Parameter
code
state
Description
The authorization code that is passed to get the access and
refresh tokens
The state value that was passed in as part of the initial
request, if applicable.
17

Introducing Chatter REST API
Understanding the Web Server OAuth Authentication Flow
It is expected that the redirect_uri web page is hosted by the client application server.
4. The client application server must extract the authorization code and pass it in a request to Database.com for an access
token. This request should be made as a POST against this URL:
https://login.instance_name/services/oauth2/token with the following query parameters:
Parameter
grant_type
client_id
client_secret
redirect_uri
code
format
Description
Value must be authorization_code for this flow.
Consumer key from the remote access application definition.
Consumer secret from the remote access application
definition.
URI to redirect the user to after approval. This must match
the value in the Callback URL field in the remote access
application definition exactly, and is the same value sent by
the initial redirect.
Authorization code obtained from the callback after approval.
Expected return format. This parameter is optional. The
default is json. Values are:
• urlencoded
• json
• xml
5. If this request is successful, the server returns a response body holding the following:
Parameters
access_token
refresh_token
Description
Session ID that you can use for making Chatter API
requests. This session ID cannot be used in the user interface.
Treat this like a user's session and diligently protect it.
Token that can be used in the future to obtain new access
tokens (sessions).
Warning: This value is a secret. You should treat
it like the user's password and use appropriate
measures to protect it.
instance_url
id
signature
URL indicating the instance of the user's organization. In
this example, the instance is na1:
https://na1.database.com
Identity URL that can be used to both identify the user as
well as query for more information about the user. Can be
used in an HTTP request to get more information about
the end user.
Base64-encoded HMAC-SHA256 signature signed with
the consumer's private key containing the concatenated ID
18

Introducing Chatter REST API
Understanding the User-Agent OAuth Authentication Flow
Parameters
issued_at
Description
and issued_at. This can be used to verify the identity
URL was not modified since it was sent by the server.
When the signature was created.
Understanding the User-Agent OAuth Authentication Flow
Typically this flow is used by mobile apps or applications that directly access the Chatter API from JavaScript. In this flow,
it is assumed that the client application can’t be trusted to store client credentials, nor the user login credentials.
Warning: Because the access token is encoded into the redirection URI, it might be exposed to the end-user and
other applications residing on the computer or device.
If you are authenticating using JavaScript, we recommend calling window.location.replace(); to remove the
callback from the browser’s history.
The following is the general flow. The individual step descriptions follow.
The following is a general description of the OAuth user-agent flow:
19

Introducing Chatter REST API
Understanding the User-Agent OAuth Authentication Flow
1. To request authorization for a resource, the client application redirects the end-user’s browser to a Web page hosted on
the resource owner’s authorization server. In this case, it’s the Database.com login page.
2. The end-user logs into Database.com to authenticate themselves. Since this Web page is hosted by the resource owner
(Database.com) and interacted with directly by the end user, the client Web application never finds out the user’s login
credentials.
If the client application is running in the browser already, the browser can just be redirected. If the client application is a
mobile app, a browser must be opened (such as an UIWebView in iOS). The end-user uses this web page to authenticate
themselves and then grant authorization to the client application.
3. Once authorization has been granted, the authorization server redirects the end-user’s Web browser to a redirection URL.
This URL can be used by the client application to retrieve the access and refresh tokens.
4. The protected resources are Chatter API resources.
Using the User-Agent Flow with Chatter API and Database.com
The following provides specific details for the OAuth user-agent flow when used with Database.com and Chatter API:
1. Direct the client’s Web browser to the page https://login.instance_name/services/oauth2/authorize, with
the following request parameters:
Parameter
response_type
client_id
redirect_url
Description
Must be token for this authentication flow
The Consumer Key value from the remote access
application defined for this application
The Callback URL value from the remote access
application defined for this application
You can also include the following optional request parameters:
Parameter
display
scope
state
Description
Indicates the type of Web page that’s provided. Valid values
are:
• page—Full-page authorization screen. This is the default
value if none is specified.
• popup—Compact dialog optimized for modern Web
browser popup windows.
• touch—mobile-optimized dialog designed for modern
smartphones such as Android and iPhone.
• mobile—mobile optimized dialog designed for older
smartphones such as BlackBerry OS 5.
Specifies what data your app can access. You do not have to
specify any value to access Chatter API If you specify any
values, you must include the chatter_api value.
Specifies URL-encoded state data to be returned in the
callback URL after approval.
20

Introducing Chatter REST API
Using Tokens
2. After successfully logging in, the user is asked to authorize the application. Note that if the user has already authorized the
application, this step is skipped.
3. Once Database.com has confirmed that the client application is authorized, the end-user’s Web browser is redirected to
the callback URL specified by the redirect_uri parameter, appended with the following values after the hash sign (#).
This is not a query string.
Parameters
access_token
expires_in
refresh_token
Description
Session ID that you can use for making Chatter API
requests. This session ID cannot be used in the user interface.
Treat this like a user's session and diligently protect it.
Amount of time the access token is valid, in seconds.
Token that can be used in the future to obtain new access
tokens (sessions).
Warning: This value is a secret. You should treat
it like the user's password and use appropriate
measures to protect it.
The refresh token is only returned if the redirect URI is
https://login.instance_name/services/oauth2/success
or used with a custom protocol that is not HTTPS.
The following additional parameters are returned; however, they aren't used with this flow and Chatter API:
• instance_url
• id
• signature
• issued_at
4. If the client application is a Web app, the redirection Web page that it uses may include JavaScript that the client application
can manipulate in order to retrieve the access and refresh tokens.
Alternatively, a client application (native or web) may use the page
https://login.instance_name/services/oauth2/success as their callback URL. Instead of actually loading
the page on redirect, they should intercept the redirection URI and extract the parameters values. Note that the
refresh_token parameter values are only provided if the redirection URI is this URI or if the redirection URI uses a
custom protocol.
Once the client application has retrieved the access and refresh tokens, it can use them to make requests to Chatter API.
Using Tokens
As part of both authentication flows, you will be working with access tokens and refresh tokens.
Using Access Tokens
To make a successful Chatter API request, you must include a valid access token in the request. This can be done by using
the HTTP Authorization header:
Authorization: OAuth
21

Introducing Chatter REST API
Requesting Static Assets and Posting Forms Directly from
HTML
If the request yields an error response due to an expired token, the refresh token can be used to get a new access token.
If the request yields an error because an access token has been revoked, the client application must be re-authorized by the
user in order to gain access.
Using Refresh Tokens
If the client application has a refresh token, it can use it to send a request for a new access token.
To ask for a new access token, the client application should send a POST request to
https://login.instance_name/services/oauth2/token with the following query parameters:
Parameters
grant_type
refresh_token
client_id
Description
Value must be refresh_token for this flow.
The refresh token the client application already received.
Consumer key from the remote access application definition.
You can also include the following optional parameters:
Parameters
client_secret
format
Description
Consumer secret from the remote access application definition.
Expected return format. The default is json. Values are:
• urlencoded
• json
• xml
If this request is successful, the server returns a payload holding the access_token.
The following additional parameters are also returned, however, they aren't used with this flow and Chatter API:
• instance_url
• id
• signature
• issued_at
Requesting Static Assets and Posting Forms Directly from HTML
HTML pages that aren’t hosted on Salesforce have had difficulty displaying user and group images and posting file attachments
in forms. The reason is that URLs for these assets require authentication, which is provided with a session cookie when pages
are hosted on Salesforce. Pages not hosted on Salesforce don't have access to the session cookie. Also, it isn’t possible to pass
an OAuth token from the HTML contexts , , and .
To solve this problem, request self-authenticating bearer token URLs. A bearer token URL is a Chatter API resource with an
appended bearer token that provides access to the resource. Use bearer token URLs in , , and tags to do
the following:
• Request static Chatter API assets such as Chatter user profile images, files, and file and dashboard previews.
22

Introducing Chatter REST API
Requesting Static Assets and Posting Forms Directly from
HTML
• Post form requests to Chatter API when files are attached, for example, feed items or comments with a file attachment,
or user profile photo updates.
To request static assets or post form requests, request a resource that returns a bearer token URL. Then use the bearer token
URL to request the resource.
1. Request a resource with a response body property that contains a bearer token URL:
• Photo—largePhotoUrl, smallPhotoUrl, url*
• Feed Item Attachment-Dashboard—fullSizeImageUrl, thumbNailUrl
• Comment Page—currentPageUrl*
• Feed Item—photoUrl
• Feed—feedItemsUrl*
• Feed Item Attachment-Content—downloadUrl, renditionUrl
• File Summary—downloadUrl, renditionUrl
• File Detail—downloadUrl, renditionUrl
*Use to POST or PUT for new items that include binary files: for example, a feed item or comment with a file attachment.
2. Pass the X-Connect-Bearer-Urls request header with a value of true:
X-Connect-Bearer-Urls: true
3. Parse the bearer token URL from the response body and use it in an HTML tag to request a static asset or to post a form
request.
Bearer token URLs have the following characteristics:
• The bearer token is good for the given URL only. Adding or reordering query parameters invalidates the URL.
• The bearer token has a time-to-live (TTL) of 20 minutes. If the token expires you must request it again.
• The request to the bearer token URL authenticates as the user who requested the resource that returned the bearer
token URL.
23

Chapter 2
Quick Start
In this chapter ...
• Prerequisites
• Step One: Set Up Authorization
• Step Two: Connect to Chatter API
Using OAuth
Create a sample application in your development environment to see the power
and flexibility of the Chatter REST API.
24

Quick Start
Prerequisites
Prerequisites
Completing the prerequisites makes it easier to build and use the quick-start sample:
• Install your development platform according to its product documentation.
• Become familiar with cURL, the tool used to execute REST requests in this quick start. If you use another tool, you should
be familiar enough with it to translate the example code.
• Become familiar with JavaScript Object Notation (JSON), which is used in this quick start, or be able to translate samples
from JSON to the standard you use.
• Enable an SSL endpoint in your application server.
• Become familiar with OAuth 2.0, which requires some setup. We provide the steps, but it will help if you are familiarize
yourself with terms and concepts.
See Also:
Quick Start
Step One: Set Up Authorization
Step One: Set Up Authorization
Setting up OAuth 2.0 requires that you take some steps within your development environment and in other locations. If any
of the steps are unfamiliar, you can consult the online help or the OAuth 2.0 documentation.
1. Decide where to create your Connected App.
Your Connected App does not have to reside in the same organization as your users. The Connected App you create can
be used to sign into any organization.
2. In the appropriate organization, navigate to Create > Apps, and in the Connected Apps section, click New to create a
new Connected App.
3. Enter a Connected App name.
4. Enter the contact email, as well as any other information appropriate to your application.
5. Enter a Callback URL. It must be secure: http:// does not work, only https://.
For development environments, the callback URL is generally the instance plus whatever URL you want the user to be
redirected to, for example: https://instance_name/ConnectTest/oauth/_callback.
6. Enter an OAuth scope. Select Access and manage your Chatter feed in addition to any other scope you want
your Connected App to allow access to.
7. Click Save.
The Consumer Key is created and displayed, and a Consumer Secret is created (click the link to reveal it).
Use this Connected App to connect to the servers.
See Also:
Quick Start
Prerequisites
Step Two: Connect to Chatter API Using OAuth
25

Quick Start
Step Two: Connect to Chatter API Using OAuth
Step Two: Connect to Chatter API Using OAuth
You must create a Connected App (such as the example in Step One: Set Up Authorization) before you can do this step.
Note: The OAuth 2.0 specification uses “client” instead of “consumer.”
The following maps the terms used in the Connected App you just created to the OAuth values used in the examples.
Connected App Application Label
Consumer Key
Consumer Secret
Callback URL
Value in Example
client_id
client_secret
redirect_uri
In addition, the value of grant_type depends on the OAuth authentication flow you are using. For this flow, the value is
password.
Important: The OAuth flow being used in this example is not suitable for production client apps because it involves
passing in the client secret. Use of the username-password flow is not recommended for most applications.
This example also uses the following values:
Note: Communities are available as a pilot program. Contact your salesforce.com representative to find out if your
organization qualifies for the community pilot.
Name
Instance
username
Consumer key
Consumer secret
Callback URL
Grant type
Password
Value
na1.database.com
admin@seattleapps.com
3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9
8870355475032095511
https://www.seattleapps.com
password
1Lsfdc!
1. Generate the access token.
The following is an example of the cURL command to generate an access token:
curl --form client_id=3MVG9PhR6g6B7ps4xDycwGrI4PvjVZvK9
--form client_secret=8870355475032095511
--form grant_type=password
--form username=admin@seattleapps.com
--form password=1Lsfdc!
https://na1.database.com/services/oauth2/token
26

Quick Start
Step Two: Connect to Chatter API Using OAuth
The following is the response that includes the access token:
{
"id":"https://login.na1.database.com/id/00DD0000000FJ6TMAW/
005D0000001B5T4IAK",
"issued_at":"1302907727777",
"instance_url":"https://na1.database.com",
"signature":"5jcevY5fUai0lWntuSxkwBzWcvRjd01RCOkIBZpyGv0=",
"access_token":"00DD0000000FJ6T!AQkAQPde_DMF2vGzddfZmBRS95GojDbtA
rKkgukAgZP0OVFYY5KkAqhLw9ejeKIlpJ3FgwGAWeRlBiWRt8mfXEuAZGbZNosk"
}
2. Access Chatter API using the access token.
curl -X GET https://na1.database.com/services/data/v27.0/chatter/users/me
-H 'Authorization: Bearer 00DD0000000FJ6T!AQkAQPde_DMF2vGzddfZmBRS95Goj
DbtArKkgukAgZP0OVFYY5KkAqhLw9ejeKIlpJ3FgwGAWeRlBiWRt8mfXEuAZGbZNosk'
See Also:
Quick Start
Step One: Set Up Authorization
27

Chapter 3
Chatter API: How do I. . .
• Filter a response body?
• Post a feed item?
• Add a comment to a record or user?
• Post a comment or feed item with an @mention?
• Post a comment or feed item with multiple @mentions?
• Like a feed item?
• Share a feed item?
• Poll my news feed for updates?
• Get my news feed?
• Search a record feed?
• Get feed items posted to a record?
• Get the list of records a specific user follows?
• Get Chatter activity statistics?
• Get recommendations of people to follow?
• Join a group?
• Request to join a private group?
• Respond to a request to join a private group?
• Post to a group?
• Follow a record?
• Unfollow a record?
• Send a private message?
• Create autocomplete for @mentions?
• Retrieve all the information for a group of users?
While using the Chatter API, keep the following in mind:
• Request parameters are included as part of the Chatter API resource URL, for example, /chatter/users?q=searchtext.
A request body is a rich input included as part of the request. When accessing a resource, you can use either a request body
or request parameters. You cannot use both.
• With a request body, use Content-Type: application/json or Content-Type: application/xml.
• With request parameters, use Content-Type: application/x-www-form-urlencoded.
For more information on request bodies, see Using POST, PATCH, or PUT for Input.
For examples of how to upload a binary file, see Uploading Binary Files.
Filter a response body
Resource:
All
28

Chatter API: How do I. . .
HTTP method:
Request body:
Request parameter:
Request body example:
GET
NA
exclude and include
Use the exclude and include query parameters to filter a response body when making a
request. The query value is a bar (|) delimited list of properties. URL encode the bar as %7C.
Use a forward slash (/) before each property name.
The following News Feed URL resource:
/chatter/users/me?include=/aboutMe%7C/address
Returns the following for the Feed response body:
{
"aboutMe": "Salesforce Administrator and Citizen Developer",
"address": {
"city": "San Francisco",
"country": "US",
"formattedAddress": "1 Market St\nSan Francisco, CA
94105\nUS",
"state": "CA",
"street": "1 Market St",
"zip": "94105"
}
}
For a detailed list of rules and examples, see Response Body Filters on page 258.
Returns:
A filtered response body
Post feed item
Resource:
HTTP method:
Request body:
Request parameter:
Use one of the feed resources, such as /chatter/feeds/news/userId/feed-items.
POST
Feed Item Input
text
29

Chatter API: How do I. . .
Request body example:
{ "body" :
{
"messageSegments" : [
{
"type": "Text",
"text" : "New post"
}
]
}
}
Request parameter
example:
/services/data/v27.0/chatter/feeds/news
/me/feed-items?text=New+post
Returns:
Feed Item
Add comments
Resource:
HTTP method:
Request body:
Request parameter:
Request body example:
/chatter/feed-items/feedItemId/comments
POST
Comment input
text
{ "body" :
{
"messageSegments" : [
{
"type": "Text",
"text" : "New comment"
}
]
}
}
Request parameter
example:
/services/data/v27.0/chatter/feed-items/
0D5D0000000DaSbKAK/comments?text=New+comment
Returns:
Comment
Post @mentions
Resource:
To post a feed-item with an @mention, use one of the feed resources, such as
/chatter/feeds/user-profile/userId/feed-items. To post a comment, use the
Feed-Items resource: /chatter/feed-items/feedItemId/comments
30

Chatter API: How do I. . .
HTTP method:
Request body:
Request body example:
POST
The appropriate container input, such as comment input or feed-item input, with the message
segment input: mention
{ "body" :
{
"messageSegments" : [
{
"type": "mention",
"id" : "005D0000001GpHp"
},
{
"type": "text",
"text" : " Did you see the new plans?"
}
]
}
}
Note: No spaces are added either before or after the @mention, so the text message
segment includes a space.
Returns
Feed Item
Post multiple @mentions
Resource:
HTTP method:
Request body:
To post a feed-item with multiple @mentions, use one of the feed resources, such as
/chatter/feeds/user-profile/userId/feed-items. To post a comment with
multiple @mentions, use the Feed-Items resource:
/chatter/feed-items/feedItemId/comments.
POST
The appropriate container input, such as comment input or feed-item input, with multiple
Message Segment Input: Mention bodies.
31

Chatter API: How do I. . .
Request body example:
{ "body" :
{
"messageSegments" : [
{
"type": "mention",
"id":"005D0000001LL8YIAW"
},
{
"type": "mention",
"id":"005D0000001LL8sIAG"
},
{
"type": "text",
"text":" Did you see the new plans?"} ]
}
]
}
}
Note: No spaces are added either before or after the @mention, so the text message
segment includes a space.
Returns
Feed Item
Like feed items
Resource:
HTTP method:
Request body:
Request parameter:
Example:
/chatter/feed-items/feedItemId/likes
POST
NA
NA
/services/data/v27.0/chatter/feed-items/0D5D0000000DaZBKA0
/likes
Returns:
Like
Share a feed item
Resource:
HTTP method:
Request body:
Request parameter:
Use one of the feed resources, such as
/chatter/feeds/user-profile/userId/feed-items.
POST
originalFeedItemId
originalFeedItemId
32

Chatter API: How do I. . .
Request body example:
{
}
"originalFeedItemId": "0D5D0000000DaZBKA0"
Returns:
Feed Item
Poll news feed
Resource: 1. Use either of the following resources to get the latest items from a news feed or to get
information about the feed: /chatter/feeds/news/me/feed-items,
/chatter/feeds/news/me.
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. Note that 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. Note that 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 Items
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.
Note: We don’t recommend polling the news feed for updates more than once a
minute.
HTTP method:
Request body:
Request parameter:
Request body example:
GET
NA
NA
The following News Feed URL resource:
/chatter/feeds/news/005xx000001Sv1mAAB
33

Chatter API: How do I. . .
Returns the following for the Feed response body:
{
"feedItemsUrl":
"/services/data/v27.0/chatter/feeds/news/005xx000001Sv1mAAB/feed-items",
"isModifiedUrl":
"/services/data/v27.0/chatter/feeds/news/005xx000001Sv1mAAB/is-modified?since=2%3A1344352279000"
}
The Is-Modified resource for polling this news feed is:
/chatter/feeds/news/005xx000001Sv1mAAB/is-modified?since=2%3A1344352279000
Returns:
Feed Modified Info
Get news feeds
The following gets the news feed of the current user.
Resource:
HTTP method:
Request body:
Request parameter:
Example:
/chatter/feeds/news/me/feed-items
GET
NA
NA
/services/data/v27.0/chatter/feeds/news/me/feed-items
Returns:
Feed Item Page
Search a record feed
The following example searches the record feed of the current user. The record can be a group, person, object, file, and
so on. For example, use this resource to search a group feed. The search string can contain wildcards and must contain at
least two characters that aren’t wildcards.
Resource:
HTTP method:
Request body:
Request parameter:
Example:
/chatter/feeds/record/me/feed-items
GET
NA
q
/services/data/v27.0/chatter/feeds
/record/me/feed-items?q=track
Returns:
Feed Item Page
34

Chatter API: How do I. . .
Get feed items for a record
Resource:
HTTP method:
Request body:
Request parameter:
/chatter/feeds/record/recordId/feed-items
GET
NA
page (optional)
Note: Page tokens are returned as part of the response body, in one of the URL
parameters, such as nextPageURL.
Request parameter
example:
/services/data/v27.0/chatter/feeds/record
/005x0000001oXx9AAE/feed-items?page=2011-03-31T20:57:24Z,0D5x0000001C2XPCA0
Returns:
Feed Item Page
Get list of what user is following
Resource:
HTTP method:
Request body:
Request parameter:
Request parameter
example:
/chatter/users/userId/following
GET
NA
page (optional)
/services/data/v27.0/chatter/users
/005D0000001GLowIAB/following?page=1
Returns:
Subscription Page
Get Chatter activity statistics
Resource:
HTTP method:
Request body:
Request parameter:
Example:
/chatter/users/userId
GET
NA
NA
/services/data/v27.0/chatter/users
/005D0000001GLowIAB
Returns:
User Detail
35

Chatter API: How do I. . .
Get recommendations
Resource:
HTTP method:
Request body:
Request parameter:
Example:
/chatter/users/me/recommendations/follow/users
GET
NA
NA
/services/data/v27.0/chatter/users
/me/recommendations/follow/users
Returns:
Recommendation
Join a group
Resource:
HTTP method:
Request body:
Request parameter:
Request body example:
Request parameter
example:
/chatter/groups/groupId/members
POST
Group member input
userId
{"userId": "005D0000001GpHp" }
/services/data/v27.0/chatter/groups/0F9D000000006bOKAQ
/members?userId=005D0000001GpHp
Returns:
Group Member
Request to join a private group
Resource:
HTTP method:
Request body:
Request parameter:
Request body example:
Request parameter
example:
/chatter/groups/groupId/members/requests
POST
NA
NA
NA
/services/data/v27.0/chatter/groups/0F9D000000006bOKAQ
/members/requests
Returns:
Group Membership Request
36

Chatter API: How do I. . .
Respond to request to join a private group
Resource:
HTTP method:
Request body:
Request parameters:
/chatter/group-memberships-requests/requestId
PATCH
Group Membership Request Update
status and responseMessage
The responseMessage parameter is used only if the value of status is Declined.
Request body example:
{
}
"status " : "Accepted"
Request parameter
example:
/services/data/v27.0/chatter/group-membership-requests
/0I5D000000002fwKAA?status=Accepted
Returns:
Group Membership Request
Post to a group
Resource:
HTTP method:
Request body:
Request parameter:
Request body example:
/chatter/feeds/record/groupId/feed-items
POST
Feed item
Text
{ "body" :
{
"messageSegments" : [
{
"type": "Text",
"text" : "Has everyone seen the latest building
proposal?"
}
]
}
}
Request parameter
example:
/feeds/record/0F9D000000006bO/feed-items?
text=Has+everyone+seen+the+latest+building+proposal?
Returns:
Feed Item
37

Chatter API: How do I. . .
Follow a record
The subjectId is the ID of the item you want to follow.
Resource:
HTTP method:
Request body:
Request parameter:
Request body example:
Request parameter
example:
/chatter/users/me/following
POST
Following input
subjectId
{ "subjectId" : "001D000000Iyu2p" }
/services/data/v27.0/chatter/users/me
/following?subjectId=001D000000Iyu2p
Returns:
Subscription
Unfollow records
Note that a complete structured resource is not returned, just a return code.
Resource:
HTTP method:
Request body:
Request parameter:
Example:
/chatter/subscriptions/subscriptionId
DELETE
NA
NA
/services/data/v27.0/chatter/subscriptions/0E8D00000001JkFKAU
Returns:
204: Successful Delete
Send a private message
Resource:
HTTP method:
Request body:
Request parameter:
/chatter/users/me/messages/
POST
Messaging input
recipients OR inReplyTo
text
38

Chatter API: How do I. . .
Request body example:
{ "body" : "Are we ready for next week's customer meeting?",
"recipients" : ["005D0000001GOYpIAO", "005D0000001GbdHIAS"]
}
Request parameters
example:
/services/data/v27.0/chatter/users
/me/messages?recipients=005D0000001GOYpIAO,
005D0000001GbdHIAS&Are+we+ready+for+next+week's+customer+meeting?
Returns:
Message
Build a user name autocomplete for @mentions
Resource:
HTTP method:
Request parameter:
Request parameters
example:
/chatter/users?q=searchtext where searchtext includes wildcards. For every two
or three characters the user types, you can add a wildcard and get the list of matching user
names. For example, /chatter/users?q=cha* finds all users whose user names begin
with "cha".
GET
q=searchtext
/services/data/v27.0/chatter/users?q=cha*
Returns:
User Page
Return all user information for multiple users
Resource:
HTTP method:
Request parameter:
Request parameters
example:
/chatter/users/batch/user_list where user_list is a list of user Ids. Your app
may need to call Chatter API twice: once to get the feed items and user Ids, the second time
to call this resource with the list of user Ids.
GET
NA
/services/data/v27.0/chatter/users
/batch/005D0000001Kl6xIAC,005D0000005J3D4HVB, . . .
Returns:
Batch Results
39

Chapter 4
Chatter API Resources
The following are Chatter API resources:
Resource
Bookmarks Resources
Chatter Resource on page 52
Comments Resources
Connect Resources
Company Feed Resources
Favorites Feed Resources
Feeds Resource on page 65
Description
Feed made up of Chatter feed items posted to bookmarks saved by the logged-in user.
Available resources are:
Bookmarks Feed URL on page 47
Bookmarks Feed Items on page 48
Directory of the general resources available. Contains a single resource.
Information about the specified comment. Also used to delete a comment, or to like a
comment.
Available resources are:
Comment on page 53
Comment Likes on page 55
Information about all possible resources, as well as the current user’s organization and
settings.
Available resources are:
Connect on page 58
Organization on page 59
A feed that displays all posts and comments from an entire company.
Available resources are:
Company Feed URL on page 56
Company Feed Items on page 57
Feeds made up of Chatter favorites saved by the logged-in user.
Available resources are:
List of Favorites on page 60
Favorite on page 62
Favorites Feed Items on page 64
A list of all of the feeds the logged in user is able to view. Contains a single resource.
40

Chatter API Resources
Resource
Feed-Items Resources
Files Resources
Files Feed Resources
Filter Feed Resources
Groups Feed Resources
Description
Represents a specific feed item. Also used to query all feed items, post comments to
feed-items, as well as delete a specific feed item.
Available resources are:
Feed-Items Query on page 68
Feed-Items, Specific Feed Item on page 69
Feed-Items Comments on page 73
Feed-Items Likes on page 77
Feed-Items Polls on page 78
Information about the specified file, including content, rendered version, and sharing.
Available resources are:
File Information on page 79
File Content on page 82
File Shares on page 82
File Rendition on page 85
File Information, Batch on page 86
All feed items that contain files posted by people or groups that the current user follows.
Available resources are:
Files Feed URL on page 86
Files Feed Items on page 87
Feeds filtered by the specified criteria for the logged-in user.
Available resources are:
List of Filters on page 90
Key Prefix Filter Feed on page 91
Key Prefix Filtered Feed Items on page 92
All feed items from all groups the current user either owns or is a member of.
Note: To get the feed for a specific group, use the Record Feed Resource
resource with a groupId.
Available resources are:
Groups Feed URL on page 94
Groups Feed Items on page 95
Group-Memberships Resources
Access information about a member of a group, or remove a member from a group.
Available resources are:
Group Memberships Information on page 98
41

Chatter API Resources
Resource
Groups Resources
Influence Resource on page 117
Likes Resource on page 118
Motifs Resources
News Feed Resources
People Feed Resources
Record Feed Resource
Description
Batch Group Memberships on page 99
Information about groups, such as the group's members, photo, and the groups in the
organization. Also used to add members to a group and change the group photo. This
is not a feed. To get the feed for a specific group, use the Record Feed Resource resource
with a groupId.
Available resources are:
List of Groups on page 101
Batch Group Information on page 105
Group Files on page 105
Group Information on page 103
Group Members on page 107
Group Members—Private on page 110
Group Membership Requests—Private on page 113
Group Photo on page 114
Group Settings on page 116
List of the percentile thresholds used to categorize an organization’s users by their
influence in Chatter. Contains a single resource.
Information about the specified like. Also used to delete a like. Contains a single resource.
Returns URLs for sets of small, medium, and large motif icons. Records have different
sets of motif icons depending on the record type.
Available resources are:
Motifs Resource on page 119
Batch Motifs Resource on page 120
The news feed of the current user. It is made up of items that are of interest to the current
user. You can also use the feed-items resource to add feed-items.
Available resources are:
News Feed URL on page 121
News Feed Is-Modified on page 122
News Feed Items on page 123
All feed items posted by all of the people the current user follows.
Available resources are:
People Feed URL on page 135
People Feed Items on page 135
The feed of the specified record, which could be a group, person, object, file and so on.
Available resources are:
42

Chatter API Resources
Resource
Records Resources
Subscriptions Resource on page 156
To Feed Resources
User-Profile Feed Resources
Users Resources
Description
Record Feed URL on page 138
Record Feed Items on page 139
Information about the specified record, including followers. This is not a feed. To access
a record feed, use the Record Feed Resource.
Available resources are:
Record Information on page 154
Record Followers on page 155
Information about the specified subscription. Also used to delete a subscription, for
example, to unfollow a record. Contains a single resource.
Feed of all @mentions of the current user and posts others make to the logged-in user's
feed.
Available resources are:
To Feed URL on page 158
To Feed Items on page 158
Feed of actions by the current user on records that can be tracked in a feed. This is
different than/chatter/feeds/news, which returns more items, including posts,
group updates, and record updates. You can also post feed items to the user-profile feed.
Available resources are:
User–Profile Feed URL on page 161
User–Profile Feed Items on page 162
Information about the user, such as who is following the user, the user’s files or
recommendations. Also used for posting feed items and updating conversation status.
This is not a feed. To access the user profile feed, use User-Profile Feed Resources.
Available resources are:
Batch User Information on page 174
Change Status of Conversations on page 177
Users Files, General on page 178
User Files, Filtered by Group on page 181
User Files, Filtered by Sharing on page 182
Following Users on page 184
User Information on page 172
User Messages, General on page 186
User Messages, Specific on page 192
User Recommendations, General on page 194
Get Unread Count for Conversations on page 178
User Conversations, General on page 174
43

Chatter API Resources
Chatter API Resources Relationships
Resource
Description
User Conversations, Specific on page 176
User Followers on page 183
User Groups on page 186
User Photo on page 193
User Profile Information on page 173
User Recommendations for a Specific Action on page 197
User Recommendations for a Specific Action and Object Category on page 197
User Recommendations for a Specific Action and Key Prefix on page 199
User Recommendations for a Specific Action and Object ID on page 200
User Settings on page 201
Chatter API Resources Relationships
Note: Communities are available as a pilot program. Contact your salesforce.com representative to find out if your
organization qualifies for the community pilot.
The following shows the relationships between the various resources.
44

Chatter API Resources
Chatter API Resources Relationships
Figure 1: Chatter API Resources Relationships Part I
45

Chatter API Resources
Chatter API Resources Relationships
Figure 2: Chatter API Resources Relationships Part II
46

Chatter API Resources
Bookmarks Resources
Bookmarks Resources
Feed made up of Chatter feed items posted to bookmarks saved by the logged-in user.
To bookmark an item, use PATCH with the Feed-Items resource and the isBookmarkedByCurrentUser parameter. For
example:
/chatter/feed-items/0D5D0000000Ir6zKAC?isBookmarkedByCurrentUser=true
Available resources are:
Resource
/chatter/feeds/bookmarks/me
/chatter/feeds/bookmarks/me/feed-items
Description
Returns the URL for the bookmarks feed for the logged-in
user.
Returns all feed items for all bookmarks for the logged-in user.
Bookmarks Feed URL
Returns the URL for the bookmarks feed for the logged-in user.
Resource
/chatter/feeds/bookmarks/me
OR
/chatter/feeds/bookmarks/userId
Note: userId must be the same as the logged-in user.
Available since version
24.0
HTTP methods
GET or HEAD
Request parameter
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
47

Chatter API Resources
Bookmarks Resources
Response body
Feed
Bookmarks Feed Items
Returns all feed items for all bookmarks for the logged-in user.
Resource
/chatter/feeds/bookmarks/me/feed-items
OR
/chatter/feeds/bookmarks/userId/feed-items
Note: userId must be the same as the logged-in user.
Available since version
24.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
Type
String
Description
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:
"nextPageUrl":
"/services/data/v27.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
sort
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
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.
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
48

Chatter API Resources
Bookmarks Resources
Parameter Name
Type
Description
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed Item Page
Example response body
{
"currentPageUrl": "/services/data/v27.0/chatter/feeds/bookmarks/
005D0000001LL8OIAW/feed-items",
"isModifiedToken": null,
"isModifiedUrl": null,
"items": [{
"actor": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl": "https://instance_name/ncsphoto/
SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sY0heczeNaGmYGdLWP8_jwf",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl": "https://instance_name/ncsphoto/
SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saxNHGd3SJobWSeBWfI9EzW",
"url": "/services/data/v27.0/chatter/users
/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
},
"attachment": null,
"body": {
"messageSegments": [{
"text": "I have contacts at this company. Feel free to ping me for
information.",
"type": "Text"
}],
"text": "I have contacts at this company. Feel free to ping me for information."
},
"canShare": true,
"clientInfo": null,
"comments": {
"comments": [],
"currentPageUrl": "/services/data/v27.0/chatter/feed-items
/0D5D0000000IYyoKAG/comments",
49

Chatter API Resources
Bookmarks Resources
"nextPageUrl": null,
"total": 0
},
"createdDate": "2012-10-30T21:38:43.000Z",
"event": false,
"id": "0D5D0000000IYyoKAG",
"isBookmarkedByCurrentUser": true,
"isDeleteRestricted": false,
"isLikedByCurrentUser": false,
"likes": {
"currentPageUrl": "/services/data/v27.0/chatter/feed-items
/0D5D0000000IYyoKAG/likes",
"likes": [],
"nextPageUrl": null,
"previousPageUrl": null,
"total": 0
},
"likesMessage": null,
"modifiedDate": "2012-11-08T20:29:48.000Z",
"myLike": null,
"originalFeedItem": null,
"originalFeedItemActor": null,
"parent": {
"id": "001D000000JDsCDIA1",
"motif": {
"largeIconUrl": "/img/icon/accounts64.png",
"mediumIconUrl": "/img/icon/accounts32.png",
"smallIconUrl": "/img/icon/accounts16.png"
},
"mySubscription": {
"id": "0E8D0000000T780KAC",
"url": "/services/data/v27.0/chatter/subscriptions
/0E8D0000000T780KAC"
},
"name": "Hazel",
"type": "Account",
"url": "/services/data/v27.0/chatter/records
/001D000000JDsCDIA1"
},
"photoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"preamble": {
"messageSegments": [
{
"motif": {
"largeIconUrl": "/img/icon/accounts64.png",
"mediumIconUrl": "/img/icon/accounts32.png",
"smallIconUrl": "/img/icon/accounts16.png"
},
"reference": {
"id": "001D000000JDsCDIA1",
"url": "/services/data/v27.0/chatter/records
/001D000000JDsCDIA1"
},
"text": "Hazel",
"type": "EntityLink"
},
{
"text": " \u2014 ",
"type": "Text"
},
{
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
50

Chatter API Resources
Bookmarks Resources
}
},
{
},
{
"reference": {
"id": "005D0000001LL8OIAW",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW"
},
"text": "Deanna Li",
"type": "EntityLink"
"text": " to ",
"type": "Text"
"text": "Universal Containers Only",
"type": "Text"
}
],
"text": "Hazel \u2014 Deanna Li to Universal Containers Only"
},
"topics": null,
"type": "TextPost",
"url": "/services/data/v27.0/chatter/feed-items/0D5D0000000IYyoKAG",
"visibility": "InternalUsers"
}],
"nextPageUrl": null
Bookmarks Feed Items Flat
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
/chatter/feeds/bookmarks/me/feed-items/flat
or
/chatter/feeds/bookmarks/userId/feed-items/flat
Note: userId must be the same as the logged-in user.
Available since version
25.0
HTTP methods
GET or HEAD
51

Chatter API Resources
Chatter Resource
Request parameters
Parameter Name
numFeedItems
page
recentCommentCount
sort
Type
Integer
String
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
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.
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.
Specifies the number of recent
comments returned. Valid values are
between 0 and 25. Default value is 3.
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
Chatter Resource
Directory of the general resources available.
Resource
/chatter
Available since version
24.0
HTTP methods
GET or HEAD
Response body
Chatter Directory
52

Chatter API Resources
Comments Resources
Example response body
{
}
"feeds": "/services/data/v27.0/chatter/feeds",
"groups": "/services/data/v27.0/chatter/groups",
"users": "/services/data/v27.0/chatter/users"
Comments Resources
Information about the specified comment. Also used to delete a comment, or to like a comment.
Available resources:
Resource
/chatter/comments/commentId
/chatter/comments/commentId/likes
Description
Returns information about the specified comment. Also used
to delete a comment.
Returns information about the likes for the specified comment.
Also used to add a like to a comment.
Comment
Returns information about the specified comment. Also used to delete a comment.
Resource
/chatter/comments/commentId
Available since version
23.0
HTTP methods
GET, DELETE or HEAD
Response body for GET or HEAD
Comment
Example
You can find the ID for a specific comment from any feed, such as a news feed or a record feed.
Use the following resource and the HTTP method GET to return information about a comment:
/chatter/comments/0D7D00000000NtkKAE
Which returns the following:
{
"attachment": null,
53

Chatter API Resources
Comments Resources
"body": {
"messageSegments": [
{
"accessible": true,
"name": "Martin Fredrick",
"text": "@Martin Fredrick",
"type": "Mention",
"user": {
"companyName": null,
"firstName": "Martin",
"id": "005D0000001LJvRIAW",
"isActive": true,
"lastName": "Fredrick",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": {
"id": "0E8D0000000T59zKAC",
"url": "/services/data/v27.0/chatter/subscriptions/0E8D0000000T59zKAC"
},
"name": "Martin Fredrick",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1i9x6Z16L8wXEGigpcWjAd",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/0_6z_M1zlQXy0iICaZWfdyWvj8Hy5cv5voDy7d7Kam12q55tdEhTcGehjW_lHrWP",
},
{
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LJvRIAW",
"userType": "Internal"
"text": " Please review.",
"type": "Text"
}
],
"text": "@Martin Fredrick Please review."
},
"clientInfo": null,
"createdDate": "2012-07-17T22:07:42.000Z",
"feedItem": {
"id": "0D5D0000000HxSuKAK",
"url": "/services/data/v27.0/chatter/feed-items/0D5D0000000HxSuKAK"
},
"id": "0D7D00000000NtkKAE",
"isDeleteRestricted": false,
"likes": {
"currentPageUrl": null,
"likes": [],
"nextPageUrl": null,
"previousPageUrl": null,
"total": 0
54

Chatter API Resources
Comments Resources
},
"myLike": null,
"parent": {
"id": "0F9D00000000HwEKAU",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000HwEKAU"
},
"type": "TextComment",
"url": "/services/data/v27.0/chatter/comments/0D7D00000000NtkKAE",
"user": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
}, "mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/0_6z_M1zlQXy0iICaZWfdyWvj8Hy5cv5voDy7d7Kam0yU5fZl49rmMAeVigTKI9v",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/0_6z_M1zlQXy0iICaZWfdyWvj8Hy5cv5voDy7d7Kam12q55tdEhTcGehjW_lHrWP",
}
}
"url": "/services/data/v27.0/chatter/users/005D0000001LLOBIA4/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
Comment Likes
Returns information about the likes for the specified comment. Also used to add a like to a comment.
Resource
/chatter/comments/commentId/likes
Available since version
23.0
HTTP methods
GET, POST or HEAD
Request parameters for GET or HEAD
Note: POST takes no request parameters, nor a request body.
55

Chatter API Resources
Company Feed Resources
Parameter Name
page
pageSize
Type
Integer
Integer
Description
Specifies the number of the page you
want returned.
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.
Response body for GET or HEAD
Like Page
Response body for POST
Like
Company Feed Resources
A feed that displays all posts and comments from an entire company. This 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.
Please note the following:
• These resources are not available for communities.
• Only the administrator for the organization has access to these resources.
Available resources are:
Resource
/chatter/feeds/company
/chatter/feeds/company/feed-items
Description
Returns a URL to the company feed.
Returns the feed items of a company feed.
Company Feed URL
Returns a URL to the company feed.
Resource
/chatter/feeds/company
Available since version
23.0
56

Chatter API Resources
Company Feed Resources
HTTP methods
GET or HEAD
Request parameters
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed
Example response body
{
}
"feedItemsUrl": "/services/data/v27.0/chatter/feeds/company/feed-items",
"isModifiedUrl": null
Company Feed Items
Returns the feed items of a company feed.
Resource
/chatter/feeds/company/feed-items
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
Type
String
Description
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
57

Chatter API Resources
Connect Resources
Parameter Name
Type
Description
parameters, such as nextPageURL, for
example:
"nextPageUrl":
"/services/data/v27.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
sort
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
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.
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed Item Page
Connect Resources
Information about all possible resources, as well as the current user’s organization and settings.
Note: These resources have the base URL of /services/data/v27.0/connect, not
/services/data/v27.0/chatter.
Available resources are:
Resource
/connect
/connect/organization
Description
List of all resources in the organization, as well as all
community resources available to the current user.
Information about the current user’s organization and settings.
Connect
Note: Communities are available as a pilot program. Contact your salesforce.com representative to find out if your
organization qualifies for the community pilot.
58

Chatter API Resources
Connect Resources
List of all resources in the organization, as well as all community resources available to the current user.
Resource
/connect
Available since version
26.0
HTTP methods
GET and HEAD
Response body
Comment Page
Organization
Information about the current user’s organization and settings.
Resource
/connect/organization
Available since version
24.0
HTTP methods
GET or HEAD
Response body
Organization
Example response body
{
"accessTimeout": 0,
"features": {
"chatter": true,
"chatterActivity": true,
"chatterGlobalInfluence": true,
"chatterMessages": true,
"chatterTopics": false,
"dashboardComponentSnapshots": false,
"feedPolling": false,
"files": true,
"filesOnComments": true,
"trendingTopics": true,
"viralInvitesAllowed": true
},
"name": "SeattleApps",
"orgId": "00DD0000000JfSyMAK",
"userSettings": {
"approvalPosts": true,
"canFollow": true,
"canModifyAllData": true,
"canOwnGroups": true,
59

Chatter API Resources
Favorites Feed Resources
}
}
"canViewAllData": true,
"canViewAllGroups": true,
"canViewAllUsers": true,
"canViewFullUserProfile": true,
"canViewPublicFiles": true,
"externalUser": false,
"hasFileSync": false,
"userId": "005D0000001LFNnIAO",
"userLocale": "en_US"
See Also:
News Feed Resources
Favorites Feed Resources
Feeds made up of Chatter favorites saved by the logged-in user. Favorites are feed searches, list views, and topics that the
logged-in user has added as a Chatter favorite.
Available resources are:
Resource
/chatter/feeds/favorites/me
/chatter/feeds/favorites/me/favoriteId
Description
Returns a list of all the favorites for the logged-in user. Creates
a favorite of a Chatter feed search.
Returns the feed for the specified favorite. Deletes the specified
favorite. Updates the last view date of the specified favorite.
/chatter/feeds/favorites/me/favoriteId/feed-items
Returns a filtered feed, only showing those feed items for the
specified favorite.
List of Favorites
Returns a list of all the favorites for the logged-in user. Creates a favorite of a Chatter feed search.
Resource
or
/chatter/feeds/favorites/me
/chatter/feeds/favorites/userId
Note: userId must be the same as the logged-in user.
Available since version
24.0
60

Chatter API Resources
Favorites Feed Resources
HTTP methods
GET, HEAD, or POST
Request body for POST
Root XML tag
Properties for POST
Name
Type
Description
Available Version
searchText
String
Text of the feed search.
This parameter can only be
used with saved searches
and not list views.
24.0
Request parameters for POST
Name
searchText
Type
String
Description
Text of the feed search. This parameter
can only be used with saved searches
and not list views.
Response body for GET or HEAD
Favorites Page
Response body for POST
Favorite
Sample response body for GET
{
"favorites": [{
"community": null,
"createdBy": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1i9x6Z16L8wXEGigpcWjAd",
61

Chatter API Resources
Favorites Feed Resources
"largePhotoUrl": "https://instance_name/profilephoto/005/F",
"photoVersionId": null,
"smallPhotoUrl": "https://instance_name/profilephoto/005/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/0_6z_M1zlQXy0iICaZWfdyWvj8Hy5cv5voDy7d7Kam12q55tdEhTcGehjW_lHrWP",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"feedUrl":
"/services/data/v27.0/chatter/feeds/favorites/me/07FD00000000Q1CMAU/feed-items",
"id": "07FD00000000Q1CMAU",
"lastViewDate": "2012-07-17T22:52:29.000Z",
"name": "dreamforce",
"searchText": "dreamforce",
"type": "Search",
"url": "/services/data/v27.0/chatter/feeds/favorites/me/07FD00000000Q1CMAU",
"user": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes", "motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
}
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1i9x6Z16L8wXEGigpcWjAd",
"largePhotoUrl": "https://instance_name/profilephoto/005/F",
"photoVersionId": null,
"smallPhotoUrl": "https://instance_name/profilephoto/005/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/0_6z_M1zlQXy0iICaZWfdyWvj8Hy5cv5voDy7d7Kam12q55tdEhTcGehjW_lHrWP",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
}
}],
"total": 1
Favorite
Returns the feed for the specified favorite. Deletes the specified favorite. Updates the last view date of the specified favorite.
Resource
/chatter/feeds/favorites/me/favoriteId
62

Chatter API Resources
Favorites Feed Resources
or
/chatter/feeds/favorites/userId/favoriteId
Note: userId must be the same as the logged-in user.
Available since version
24.0
HTTP methods
GET, HEAD, PATCH, or DELETE
Request parameter for GET or HEAD
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Request body for PATCH
Root XML tag
Properties for PATCH
Name
Type
Description
Available Version
updateLastViewDate
Boolean
Sets the last view date of
the specified feed favorite
to the current system time.
Default value is false.
24.0
Request parameter for PATCH
Parameter Name
updateLastViewDate
Type
Boolean
Description
Sets the last view date of the specified
feed favorite to the current system time.
Default value is false.
63

Chatter API Resources
Favorites Feed Resources
Response body for GET or HEAD
Favorite
Response body for PATCH
Favorite
Favorites Feed Items
Returns a filtered feed, only showing those feed items for the specified favorite.
Resource
/chatter/feeds/favorites/me/favoriteId/feed-items
or
/chatter/feeds/favorites/userId/favoriteId/feed-items
Note: userId must be the same as the logged-in user.
Available since version
24.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
Type
String
Description
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:
"nextPageUrl":
"/services/data/v27.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
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.
64

Chatter API Resources
Feeds Resource
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed Item Page
Feeds Resource
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.
Resource
/chatter/feeds/
Available since version
23.0
HTTP methods
GET or HEAD
Response body
Feed Directory
Example response body
{
"favorites": [{
"community": null,
"createdBy": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
65

Chatter API Resources
Feeds Resource
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T"
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"feedUrl":
"/services/data/v27.0/chatter/feeds/favorites/me/07FD00000000Q1CMAU/feed-items",
"id": "07FD00000000Q1CMAU",
"lastViewDate": "2012-07-17T22:52:29.000Z",
"name": "dreamforce",
"searchText": "dreamforce",
"type": "Search",
"url": "/services/data/v27.0/chatter/feeds/favorites/me/07FD00000000Q1CMAU",
"user": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T"
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
}
}],
"feeds": [
{
"feedItemsUrl": "/services/data/v27.0/chatter/feeds/bookmarks/me/feed-items",
},
{
"feedUrl": "/services/data/v27.0/chatter/feeds/bookmarks/me",
"label": "Bookmarked"
"feedItemsUrl": "/services/data/v27.0/chatter/feeds/files/me/feed-items",
"feedUrl": "/services/data/v27.0/chatter/feeds/files/me",
66

Chatter API Resources
Feed-Items Resources
},
{
},
{
},
{
},
{
},
{
"label": "Files"
"feedItemsUrl": "/services/data/v27.0/chatter/feeds/groups/me/feed-items",
"feedUrl": "/services/data/v27.0/chatter/feeds/groups/me",
"label": "Groups"
"feedItemsUrl": "/services/data/v27.0/chatter/feeds/news/me/feed-items",
"feedUrl": "/services/data/v27.0/chatter/feeds/news/me",
"label": "What I Follow"
"feedItemsUrl": "/services/data/v27.0/chatter/feeds/people/me/feed-items",
"feedUrl": "/services/data/v27.0/chatter/feeds/people/me",
"label": "People"
"feedItemsUrl": "/services/data/v27.0/chatter/feeds/record/me/feed-items",
"feedUrl": "/services/data/v27.0/chatter/feeds/record/me",
"label": "Record"
"feedItemsUrl": "/services/data/v27.0/chatter/feeds/to/me/feed-items",
"feedUrl": "/services/data/v27.0/chatter/feeds/to/me",
"label": "To Me"
},
{
"feedItemsUrl": "/services/data/v27.0/chatter/feeds/user-profile/me/feed-items",
]
}
"feedUrl": "/services/data/v27.0/chatter/feeds/user-profile/me",
"label": "User Profile"
Feed-Items Resources
Represents a specific feed item. Also used to query all feed items, post comments to feed-items, as well as delete a specific
feed item.
Available resources:
Resource
/chatter/feed-items?q=searchTerm
/chatter/feed-items/feedItemId
Description
Used to search for specific feed items.
The query parameter (q) is required with
this resource. All types of feed items are
searched, including tracked changes. A
search returns feed items with the search
term in the feed item body, as well as feed
items that have comments that contain
the search term.
Used to access or delete a specific feed
item. Also used to mark a feed item as
bookmarked.
67

Chatter API Resources
Feed-Items Query
Resource
/chatter/feed-items/feedItemId/comments
/chatter/feed-items/feedItemId/likes
Description
Access the latest three comments for a
specific feed item or post a comment.
Used to access likes for a specific feed
item, or to add a like to a specific feed
item.
Feed-Items Query
Used to search for specific feed items. The query parameter (q) is required with this resource. All types of feed items are
searched, including tracked changes. A search returns feed items with the search term in the feed item body, as well as feed
items that have comments that contain the search term. You can also use wildcards with the query parameter.
Resource
/chatter/feed-items?q=searchTerm
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
Type
Description
Available
Since
page
String
A generated token that indicates the view of feed items in the
feed.
23.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.
23.0
q
String
Specifies the string to search. The search string must contain
at least two characters, not including any wildcards. For more
information about wildcards, see Using Wildcards.
23.0
Note: The query parameter searches all types of feed items, including tracked changes. The search returns feed
items with the search term in the feed item body, as well as feed items that have comments that contain the
search term.
Response body
Feed Item Page
68

Chatter API Resources
Feed-Items, Specific Feed Item
Feed-Items, Specific Feed Item
Used to access or delete a specific feed item. Also used to mark a feed item as bookmarked.
Resource
/chatter/feed-items/feedItemId
Available since version
23.0
HTTP methods
GET, DELETE, PATCH, or HEAD
Request body for PATCH
In XML form, the root XML tag is expected to be .
Parameter Name
isBookmarkedByCurrentUser
Type
Boolean
Description
Specify true to add the current feed
item to the list of bookmarked feed
items for the current user. Specify
false to remove this feed item from
the list of bookmarked feed items for
the current user.
Request parameter for PATCH
Parameter Name
isBookmarkedByCurrentUser
Type
Boolean
Description
Specify true to add the current feed
item to the list of bookmarked feed
items for the current user. Specify
false to remove this feed item from
the list of bookmarked feed items for
the current user.
Response body for GET, PATCH, or HEAD
Feed Item
Example response body
{
"actor": {
"companyName": "Universal Containers",
"firstName": "Pam",
"id": "005D0000001LLOBIA4",
"isActive": true,
"lastName": "Jones",
69

Chatter API Resources
Feed-Items, Specific Feed Item
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": {
"id": "0E8D0000000T5ZeKAK",
"url": "/services/data/v27.0/chatter/subscriptions/0E8D0000000T5ZeKAK"
},
"name": "Pam Jones",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEMr0vGaMXWexPO6dLMe-pvnqPDbj_JcECRt9UYGCUHS",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJP/F",
"photoVersionId": "729D00000000LJPIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJP/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEMr0vGaMXWexPO6dLMe-psauUpms4pS8qMTLGMq5tZR",
"url": "/services/data/v27.0/chatter/users/005D0000001LLOBIA4/photo"
},
"title": "IT Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LLOBIA4",
"userType": "Internal"
},
"attachment": {
"choices": [
{
"id": "09AD000000000AxMAI",
"position": 1,
"text": "Developer Console",
"voteCount": 1,
"voteCountRatio": 1
},
{
"id": "09AD000000000AyMAI",
"position": 2,
"text": "Force.com IDE",
"voteCount": 0,
"voteCountRatio": 0
}
],
"myChoiceId": "09AD000000000AxMAI",
"totalVoteCount": 1
},
"body": {
"messageSegments": [{
"text": "Which dev tool do you use more often?",
"type": "Text"
}],
"text": "Which dev tool do you use more often?"
},
"canShare": false,
"clientInfo": null,
"comments": {
"comments": [{
"attachment": null,
"body": {
"messageSegments": [{
"text": "I use the ANT Migration Tool more than either of these.",
"type": "Text"
}],
"text": "I use the ANT Migration Tool more than either of these."
},
70

Chatter API Resources
Feed-Items, Specific Feed Item
"clientInfo": null,
"createdDate": "2012-09-12T23:54:42.000Z",
"feedItem": {
"id": "0D5D0000000HwlIKAS",
"url": "/services/data/v27.0/chatter/feed-items/0D5D0000000HwlIKAS"
},
"id": "0D7D00000000NyKKAU",
"isDeleteRestricted": false,
"likes": {
"currentPageUrl":
"/services/data/v27.0/chatter/comments/0D7D00000000NyKKAU/likes",
"likes": [],
"nextPageUrl": null,
"previousPageUrl": null,
"total": 0
},
"likesMessage": null,
"myLike": null,
"parent": {
"id": "0F9D00000000I4OKAU",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000I4OKAU"
},
"type": "TextComment",
"url": "/services/data/v27.0/chatter/comments/0D7D00000000NyKKAU",
"user": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
}
}],
"currentPageUrl":
"/services/data/v27.0/chatter/feed-items/0D5D0000000HwlIKAS/comments",
"nextPageUrl": null,
"total": 1
},
"createdDate": "2012-09-12T00:58:52.000Z",
"event": false,
"id": "0D5D0000000HwlIKAS",
"isBookmarkedByCurrentUser": true,
71

Chatter API Resources
Feed-Items, Specific Feed Item
"isDeleteRestricted": false,
"isLikedByCurrentUser": false,
"likes": {
"currentPageUrl":
"/services/data/v27.0/chatter/feed-items/0D5D0000000HwlIKAS/likes",
"likes": [],
"nextPageUrl": null,
"previousPageUrl": null,
"total": 0
},
"likesMessage": null,
"modifiedDate": "2012-09-12T23:54:42.000Z",
"myLike": null,
"originalFeedItem": null,
"originalFeedItemActor": null,
"parent": {
"canHaveChatterGuests": false,
"community": null,
"description": "A group for people building Force.com apps.",
"fileCount": 1,
"id": "0F9D00000000I4OKAU",
"lastFeedItemPostDate": "2012-09-13T16:11:51.000Z",
"memberCount": 2,
"motif": {
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},
"myRole": "GroupOwner",
"mySubscription": {
"id": "0FBD00000002vOVOAY",
"url": "/services/data/v27.0/chatter/group-memberships/0FBD00000002vOVOAY"
},
"name": "App Builders",
"owner": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl":
"https://instance_namec.na1-blitz02.content.soma.force.com/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.027.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
},
72

Chatter API Resources
Feed-Items Comments
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/0_6z_M1zlQXy0iICaZWfdyMkZkpEttUCohuRK3CoTiCHVH-ymjcxVfbaCBWV-Myc",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJK/F",
"photoVersionId": "729D00000000LJKIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJK/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/0_6z_M1zlQXy0iICaZWfdyMkZkpEttUCohuRK3CoTiB0odq_wQk-3SKlQQYp-u8G",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"type": "CollaborationGroup",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000I4OKAU",
"visibility": "PublicAccess"
},
"photoUrl": "https://instance_name/profilephoto/729D00000000LJP/T",
"preamble": {
"messageSegments": [{
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"reference": {
"id": "005D0000001LLOBIA4",
"url": "/services/data/v27.0/chatter/users/005D0000001LLOBIA4"
},
"text": "Pam Jones",
"type": "EntityLink"
}],
"text": "Pam Jones"
},
"topics": null,
"type": "PollPost",
"url": "/services/data/v27.0/chatter/feed-items/0D5D0000000HwlIKAS",
"visibility": "AllUsers"
Feed-Items Comments
Access the latest three comments for a specific feed item or post a comment.
For information about posting a comment, see Using POST, PATCH, or PUT for Input.
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 Uploading Binary Files.
Resource
/chatter/feed-items/feedItemId/comments
Available since version
23.0
HTTP methods
GET, POST or HEAD
73

Chatter API Resources
Feed-Items Comments
Request body for POST
Root XML tag
Properties
Name
attachment
Type
Depends on type.
Description
Optional. Values are:
• Attachment Input: Existing Content
• Attachment Input: New File Upload
Note: To upload a new file,
you must include it in a
multipart/form–data message.
See Uploading Binary Files.
Available
Version
24.0
body
Message Body Input
Description of message body
23.0
Request parameters for POST
Parameters for attaching an existing file
Parameter Name
Type
Description
Required or Optional
Available Version
attachmentType
String
The type of attachment. Must contain
the value ExistingContent.
Required
27.0
contentDocumentId
String
ID of an existing file to be posted.
Required
24.0
text
String
Text of the comment.
Optional
23.0
Parameters for attaching a new file
Parameter Name
Type
Description
Required or Optional
Available Version
attachmentType
String
The type of attachment. Must contain
the value NewFile.
Required
27.0
desc
String
Description of file being posted.
Optional
24.0
text
String
Text of the comment.
Optional
23.0
title
String
Title of the file.
Required
24.0
Parameters for posting text
74

Chatter API Resources
Feed-Items Comments
Parameter Name
Type
Description
Required or Optional Available Version
text
String
The comment text.
Required
23.0
Request parameters for GET or HEAD
Parameter Name
Type
Description
Required or Optional
Available Version
page
String
A generated token that Optional
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.
23.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
Response body for GET or HEAD
Comment Page
Response body for POST
Comment
Example response body using POST
{
"comments": [{
"attachment": null,
"body": {
"messageSegments": [
{
"accessible": true,
"name": "Martin Fredrick",
"text": "@Martin Fredrick",
"type": "Mention",
"user": {
"companyName": null,
"firstName": "Martin",
"id": "005D0000001LJvRIAW",
"isActive": true,
"lastName": "Fredrick",
"mySubscription": {
"id": "0E8D0000000T59zKAC",
"url":
"/services/data/v27.0/chatter/subscriptions/0E8D0000000T59zKAC"
},
75

Chatter API Resources
Feed-Items Comments
"name": "Martin Fredrick",
"photo": {
"largePhotoUrl":
"https://instance_name/profilephoto/729D000000007ux/F",
"photoVersionId": "729D000000007ux",
"smallPhotoUrl":
"https://instance_name/profilephoto/729D000000007ux/T"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LJvRIAW",
"userType": "Internal"
}
},
{
"text": " Please review.",
"type": "Text"
}
],
"text": "@Martin Fredrick Please review."
},
"clientInfo": null,
"createdDate": "2012-07-17T22:07:42.000Z",
"feedItem": {
"id": "0D5D0000000HxSuKAK",
"url": "/services/data/v27.0/chatter/feed-items/0D5D0000000HxSuKAK"
},
"id": "0D7D00000000NtkKAE",
"isDeleteRestricted": false,
"likes": {
"currentPageUrl": null,
"likes": [],
"nextPageUrl": null,
"previousPageUrl": null,
"total": 0
},
"myLike": null,
"parent": {
"id": "0F9D00000000HwEKAU",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000HwEKAU"
},
"type": "TextComment",
"url": "/services/data/v27.0/chatter/comments/0D7D00000000NtkKAE",
"user": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"largePhotoUrl": "https://instance_name/profilephoto/729D000000007ux/F",
"photoVersionId": "729D000000007ux",
"smallPhotoUrl": "https://instance_name/profilephoto/729D000000007ux/T"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
}
}],
"currentPageUrl":
"/services/data/v27.0/chatter/feed-items/0D5D0000000HxSuKAK/comments",
"nextPageUrl": null,
76

Chatter API Resources
Feed-Items Likes
}
"total": 1
Feed-Items Likes
Used to access likes for a specific feed item, or to add a like to a specific feed item.
Resource
/chatter/feed-items/feedItemId/likes
Available since version
23.0
HTTP methods
GET, POST or HEAD
Request parameters for GET or HEAD
Note: There aren’t any request parameters for POST.
Parameter Name
page
pageSize
Type
Integer
Integer
Description
Specifies the number of the page you
want returned.
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.
Response body for GET or HEAD
Like Page
Response body for POST
Like
Example response body with GET
{
"currentPageUrl": "/services/data/v27.0/chatter/feed-items/0D5D0000000IPZuKAO/likes",
"likes": [{
"id": "0I0D000000003KeKAI",
"likedItem": {
"id": "0D5D0000000IPZuKAO",
"url": "/services/data/v27.0/chatter/feed-items/0D5D0000000IPZuKAO"
},
"url": "/services/data/v27.0/chatter/likes/0I0D000000003KeKAI",
"user": {
77

Chatter API Resources
Feed-Items Polls
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
}
}],
"nextPageUrl": null,
"previousPageUrl": null,
"total": 1
Feed-Items Polls
Used to access or vote in an existing poll.
Resource
/chatter/feed-items/feedItemId/poll
The feedItemId must have the type PollPost.
Available since version
26.0
HTTP methods
GET, PATCH or HEAD
Use PATCH to either vote in an existing poll, or change the current user’s vote.
Request body for PATCH
Root XML tag
78

Chatter API Resources
Files Resources
Properties
Name
myChoiceId
Type
String
Description
Id of an existing choice on 26.0
the feed poll. Used to
specify the Id of the poll
choice that the current user
is voting on.
Available Version
Request parameters for PATCH
Name
Type
Description
Available Version
myChoiceId
String
Id of an existing choice on
the feed poll. Used to specify
the Id of the poll choice that
the current user is voting on.
26.0
Response body
Feed Item Attachment: Poll
Files Resources
Information about the specified file, including content, rendered version, and sharing.
Available resources are:
Resource
/chatter/files/fileId
/chatter/files/fileId/content
/chatter/files/fileId/file-shares
/chatter/files/fileId/rendition
/chatter/files/batch/fileIds
Description
Return details about the specified file. Can also be used to
rename an existing file.
Return the content of the file. The content is streamed as the
body of the response.
Returns information about the entities with which the specified
file has been shared. These can be users, groups, or records.
Returns a rendition of the file. A rendition is a binary preview
of the file. The format of the binary depends on the format
specified in the request.
Returns information for a list of files, specified by file IDs.
File Information
Return details about the specified file. Can also be used to rename an existing file.
79

Chatter API Resources
Files Resources
Resource
/chatter/files/fileId
Available since version
24.0
HTTP methods
GET, POST, PATCH, DELETE, or HEAD
Note: POST, PATCH, and DELETE available since version 26.0.
Request body for POST
Can only be used to update an existing file.
Name
Type
Description
Available Version
desc
String
Description of the file to be
uploaded
24.0
title
String
Title of the file
24.0
Request parameters for GET or HEAD
Name
versionNumber
Type
Integer
Description
Specify an existing version number for
the file. If not specified, the latest
version is returned.
Request parameters for PATCH
Name
title
Type
String
Description
Specify a new title for the file. Used to
rename an existing file.
Response body for GET, POST, PATCH, or HEAD
File Details
Response body for DELETE
Returns a status code of 204.
80

Chatter API Resources
Files Resources
Example response body
{
"checksum": "a65b71bc6a31fa95dd0a9232c9f58c86",
"contentSize": 100377,
"contentUrl": null,
"description": null,
"downloadUrl":
"/services/data/v27.0/chatter/files/069D00000001E32IAE/content?versionNumber=1",
"fileExtension": "png",
"fileType": "Png",
"flashRenditionStatus": "Na",
"id": "069D00000001E32IAE",
"isInMyFileSync": false,
"mimeType": "image/png",
"modifiedDate": "2012-07-17T21:47:27.000Z",
"motif": {
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png"
},
"mySubscription": null,
"name": "Recruitment Poster",
"origin": "Chatter",
"owner": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"pageCount": 0,
"pdfRenditionStatus": "Na",
"renditionUrl": "/services/data/v27.0/chatter/files/069D00000001E32IAE/rendition",
"thumb120By90RenditionStatus": "Success",
"thumb240By180RenditionStatus": "Success",
"thumb720By480RenditionStatus": "Success",
"title": "Recruitment Poster",
"type": "ContentDocument",
"url": "/services/data/v27.0/chatter/files/069D00000001E32IAE?versionNumber=1",
"versionNumber": "1"
81

Chatter API Resources
Files Resources
File Content
Return the content of the file. The content is streamed as the body of the response.
Resource
/chatter/files/fileId/content
Available since version
24.0
HTTP methods
GET
Request parameters
Name
versionNumber
Type
Integer
Description
Specify an existing version number for
the file. If not specified, the latest
version is returned.
Response body
Binary stream of the file content.
File Shares
Returns information about the entities with which the specified file has been shared. These can be users, groups, or records.
Resource
/chatter/files/fileId/file-shares
Available since version
24.0
HTTP methods
GET or HEAD
Response body for GET or HEAD
File Shares Page
Example response body for GET or HEAD
{
"currentPageUrl": "/services/data/v27.0/chatter/files/069D00000001E32IAE/file-shares",
"nextPageUrl": null,
"previousPageUrl": null,
"shares": [
{
82

Chatter API Resources
Files Resources
"entity": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
},
{
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"sharingType": "I"
"entity": {
"companyName": null,
"firstName": "Desmond",
"id": "005D0000001LJvOIAW",
"isActive": true,
"lastName": "Catillo",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": {
"id": "0E8D0000000T59yKAC",
"url": "/services/data/v27.0/chatter/subscriptions/0E8D0000000T59yKAC"
},
"name": "Desmond Catillo",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000KMS/F",
"photoVersionId": "729D00000000KMS",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000KMS/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "Senior Developer",
83

Chatter API Resources
Files Resources
},
{
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LJvOIAW",
"userType": "Internal"
},
"sharingType": "C"
"entity": {
"canHaveChatterGuests": false,
"community": null,
"description": null,
"fileCount": 1,
"id": "0F9D00000000HwEKAU",
"lastFeedItemPostDate": "2012-07-17T22:07:42.000Z",
"memberCount": 1,
"motif": {
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},
"myRole": "GroupOwner",
"mySubscription": {
"id": "0FBD00000002vAmOAI",
"url": "/services/data/v27.0/chatter/group-memberships/0FBD00000002vAmOAI"
},
"name": "Dreamforce '12",
"owner": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000MMK/F",
84

Chatter API Resources
Files Resources
"photoVersionId": "729D00000000MMK",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000MMK/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
}
]
}
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO/photo"
},
"type": "CollaborationGroup",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000HwEKAU",
"visibility": "PublicAccess"
},
"sharingType": "V"
File Rendition
Returns a rendition of the file. A rendition is a binary preview of the file. The format of the binary depends on the format
specified in the request.
Note: Renditions are processed asynchronously and may not be available immediately after the file has been uploaded.
Resource
/chatter/files/fileId/rendition
Available since version
24.0
HTTP methods
GET
Request parameters
Name
page
type
Type
Integer
String
Description
Specify a rendition of a specific page.
The first page is 0. If you don’t specify
a specific page, a rendition of the first
page is returned.
For a PDF file rendition, the rendition
is for the entire document. The only
valid value is 0: you can’t get the
rendition of a single page.
Specify the type of rendition to be
returned. Default value is
THUMB120BY90. Valid values are:
• FLASH
• PDF
85

Chatter API Resources
Files Feed Resources
Name
Type
Description
• SLIDE
• THUMB120BY90
• THUMB240BY180
• THUMB720BY480
Response body
Binary stream of the rendition.
File Information, Batch
Returns information for a list of files, specified by file IDs. The number of file Ids you can specify is limited by the length of
the URL. In general, you can specify up to 100 file Ids in a comma-separated list.
Resource
/chatter/files/batch/fileIds
Available since version
26.0
HTTP methods
GET
Response body
Batch Results
Files Feed Resources
All feed items that contain files posted by people or groups that the current user follows.
Available resources are:
Resource
/chatter/feeds/files/me
/chatter/feeds/files/me/feed-items
Description
Returns the URL to the feed-items that contain files that are
posted by users or groups the current user is following.
Returns all feed items posted with files by people or groups
that the logged-in user follows.
Files Feed URL
Returns the URL to the feed-items that contain files that are posted by users or groups the current user is following.
86

Chatter API Resources
Files Feed Resources
Resource
/chatter/feeds/files/me
OR
/chatter/feeds/files/userId
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
Request parameter
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed
Files Feed Items
Returns all feed items posted with files by people or groups that the logged-in user follows.
Resource
/chatter/feeds/files/me/feed-items
or
/chatter/feeds/files/userId/feed-items
Note: userId must be the same as the logged-in user.
Available since version
23.0
87

Chatter API Resources
Files Feed Resources
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
Type
String
Description
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:
"nextPageUrl":
"/services/data/v27.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
sort
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
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.
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed Item Page
Response body example
{
"currentPageUrl" :
"/services/data/v27.0/chatter/feeds/files/005D0000001L3zVIAS/feed-items?page=2012-04-17T18%3A13%3A57Z",
"isModifiedToken" : null,
"isModifiedUrl" : null
"items" : [ ],
"nextPageUrl" : null,
}
Files Feed Items Flat
This resource is deprecated as of version 26.0.
88

Chatter API Resources
Files Feed Resources
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
/chatter/feeds/files/me/feed-items/flat
or
/chatter/feeds/files/userId/feed-items/flat
Note: userId must be the same as the logged-in user.
Available since version
25.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
numFeedItems
page
recentCommentCount
sort
Type
Integer
String
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
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.
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.
Specifies the number of recent
comments returned. Valid values are
between 0 and 25. Default value is 3.
Sorts the returned feed either by
created date in ascending order, or by
last modified date, also in ascending
order. The default is
LastModifiedDateDesc
89

Chatter API Resources
Filter Feed Resources
Response body
Flat Feed
Filter Feed Resources
Feeds filtered by the specified criteria for the logged-in user.
A filter feed is a feed across many things. For example, suppose you’re a member of five groups. The following resource returns
all of the feed items visible to you that are posted to all five of those groups:
/chatter/feeds/filter/me/0F9/feed-items
Contrast that with the following, which returns all of the feed items posted to a particular group:
/chatter/feeds/record/0F9XXXXXXXXX
Note that for the filter feed, it only returns the posts visible to you. The filter feed is very similar to the news feed, just filtered
to show only objects of the specified type. In the second case, if the group is public, even if you are not a member, the resource
returns all the feed items posted to it. Because you are not a member of this group, the first example would not return these
posts.
Available resources are:
Resource
/chatter/feeds/filter/me
/chatter/feeds/filter/me/idPrefix
/chatter/feeds/filter/me/idPrefix/feed-items
Description
Use this resource to return a list of the
possible filters for a user. You should get
this list, then construct additional
resource URLs using the key prefixes that
are returned.
Use this resource to return the URL for
the specified key prefix feed.
Use this resource to return the feed items
for the specified key prefix, such as the
feed items from all the groups the
logged-in user is a member of.
List of Filters
Use this resource to return a list of the possible filters for a user. 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.
Resource
or
/chatter/feeds/filter/me
/chatter/feeds/filter/userId
90

Chatter API Resources
Filter Feed Resources
userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
Response body
Feed Directory
Key Prefix Filter Feed
Use this resource to return the URL for the specified key prefix 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.
Resource
/chatter/feeds/filter/me/keyPrefix
or
/chatter/feeds/filter/userId/keyPrefix
userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed
91

Chatter API Resources
Filter Feed Resources
Example response body
The following is an example of a URL that’s filtered by user Id, that is prefix 005.
{
"feedItemsUrl":
"/services/data/v27.0/chatter/feeds/filter/005D0000001Gl4rIAC/005/feed-items",
}
"isModifiedUrl": null
Key Prefix Filtered Feed Items
Use this resource to return the feed items for the specified key prefix, such as the feed items from all the groups the logged-in
user is a member of.
Resource
/chatter/feeds/filter/me/keyPrefix/feed-items
or
/chatter/feeds/filter/userId/keyPrefix/feed-items
userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
Type
String
Description
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:
"nextPageUrl":
"/services/data/v27.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
Integer
Specifies the number of items per page.
Valid values are between 1 and 100. If
92

Chatter API Resources
Filter Feed Resources
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
you don't specify a size, the default is
25.
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed Item Page
Filter Feed Items Flat
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
/chatter/feeds/filter/me/feed-items/flat
or
/chatter/feeds/filter/userId/feed-items/flat
Note: userId must be the same as the logged-in user.
Available since version
25.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
numFeedItems
Type
Integer
Description
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
93

Chatter API Resources
Groups Feed Resources
Parameter Name
page
recentCommentCount
sort
Type
String
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
recentCommentCount is greater than
1, 50 flat feed items are returned.
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.
Specifies the number of recent
comments returned. Valid values are
between 0 and 25. Default value is 3.
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
Groups Feed Resources
All feed items from all groups the current user either owns or is a member of.
Available resources are:
Resource
/chatter/feeds/groups/me
/chatter/feeds/groups/me/feed-items
Description
Returns a URL to the feed-items for all the groups the current,
signed-in user is a member of.
Returns all feed items from all groups the current user either
owns or is a member of.
Groups Feed URL
Returns a URL to the feed-items for all the groups the current, signed-in user is a member of.
Resource
or
/chatter/feeds/groups/me
/chatter/feeds/groups/userId
94

Chatter API Resources
Groups Feed Resources
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed
Groups Feed Items
Returns all feed items from all groups the current user either owns or is a member of.
Resource
/chatter/feeds/groups/me/feed-items
or
/chatter/feeds/groups/userId/feed-items
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
95

Chatter API Resources
Groups Feed Resources
Request parameters
Parameter Name
page
Type
String
Description
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:
"nextPageUrl":
"/services/data/v27.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
sort
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
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.
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed Item Page
Groups Feed Items Flat
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
/chatter/feeds/groups/me/feed-items/flat
or
/chatter/feeds/groups/userId/feed-items/flat
Note: userId must be the same as the logged-in user.
96

Chatter API Resources
Group-Memberships Resources
Available since version
25.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
numFeedItems
page
recentCommentCount
sort
Type
Integer
String
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
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.
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.
Specifies the number of recent
comments returned. Valid values are
between 0 and 25. Default value is 3.
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
See Also:
Groups Resources
Group-Memberships Resources
Information about memberships in Chatter groups.
Available resources are:
97

Chatter API Resources
Group-Memberships Resources
Resource
/chatter/group-memberships/membershipId
/chatter/group-memberships/batch/membershipIds
Description
Access information about a member of a group, or remove a
member from a group.
Access information about a list of group members.
Group Memberships Information
Access information about a member of a group, or remove a member from a group.
Membership IDs are returned from the /chatter/groups/groupId/memberships resource.
Resource
/chatter/group-memberships/membershipId
Available since version
23.0
HTTP methods
GET, DELETE or HEAD
Response body for GET or HEAD
Group Member
Response body example for GET
{
"id": "0FBD00000002kYFOAY",
"role": "GroupOwner",
"url": "/services/data/v27.0/chatter/group-memberships/0FBD00000002kYFOAY",
"user": {
"companyName": "Seattle Apps",
"firstName": "Adam",
"id": "005D0000001Gl4rIAC",
"isActive": true,
"lastName": "Grant",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Adam Grant",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D000000007ux/F",
"smallPhotoUrl": "https://instance_name/profilephoto/729D000000007ux/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": "Service Engineer",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001Gl4rIAC",
98

Chatter API Resources
Group-Memberships Resources
}
}
"userType": "Internal"
Batch Group Memberships
Access information about a list of group members. The members don’t have to belong to the same group. Each membership
ID is associated with a specific group.
Membership IDs are returned in the response bodies of several groups resources.
The following groups resource lists every member of a group in its own Group Member response body. The id property of
every Group Member response body contains a membership Id:
/chatter/groups/groupId/members
Resource
/chatter/group-memberships/batch/membershipIds
Where membershipIds is a comma separated list of membership IDs.
Available since version
27.0
HTTP methods
GET, HEAD
Response body for GET or HEAD
Batch Results
Example for GET
This request gets the group membership information for two users:
/services/data/v27.0/chatter/group-memberships/batch/0FBD00000003GAPOA2,0FBD00000003GAKOA
This is the Batch Results response body which contains nested User Summary response bodies:
{"results": [
{
"result": {
"id": "0FBD00000003GAPOA2",
"role": "StandardMember",
"url": "/services/data/v27.0/chatter/group-memberships/0FBD00000003GAPOA2",
"user": {
"companyName": "Universal Containers",
"firstName": "Gordon",
"id": "005D0000001LLO1IAO",
"isActive": true,
"lastName": "Johnson",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
99

Chatter API Resources
Group-Memberships Resources
"mySubscription": {
"id": "0E8D0000000T5ZUKA0",
"url": "/services/data/v27.0/chatter/subscriptions/0E8D0000000T5ZUKA0"
},
"name": "Gordon Johnson",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-zWLMxsSybO7lwUPg5_Xne",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/F",
"photoVersionId": "729D00000000LJLIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u_2Vnyzx4jZ2zFiKBz_sTt2",
},
{
"url": "/services/data/v27.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "VP Sales",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO1IAO",
"userType": "Internal"
}
},
"statusCode": 200
"result": {
"id": "0FBD00000003GAKOA2",
"role": "GroupOwner",
"url": "/services/data/v27.0/chatter/group-memberships/0FBD00000003GAKOA2",
"user": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
}
},
"statusCode": 200
100

Chatter API Resources
Groups Resources
}
]}
Groups Resources
Information about groups, such as the group's members, photo, and the groups in the organization. Also used to add members
to a group and change the group photo.
Note: The groups resource is not a feed. To view the feed for a group, or post to it, use the record feed resource with
a groupId.
Available resources:
Resource
/chatter/groups/
/chatter/groups/groupId
/chatter/groups/batch/group_list
/chatter/groups/groupID/files
/chatter/groups/groupId/members
/chatter/groups/groupId/members/requests
/chatter/group-membership-requests/requestId
/chatter/groups/groupId/my-settings
/chatter/groups/groupId/photo
Description
Returns a list of groups in the organization.
Returns information about the specified group.
Returns information about more than one group at the same
time.
Returns information about the files posted to the specified
group.
Returns a list of members for the specified group. Also use
this resource and POST to add members to a group.
Request membership in a private group or get the status of
requests to a join a private group.
Update the status of a request by a user to join a private group
or get information about a request to join a private group.
Information about the context user’s Chatter settings for the
specified group.
Use this resource to access the photo for the specified group,
add, update, or delete the photo.
See Also:
Groups Feed Resources
List of Groups
Returns a list of groups in the organization.
101

Chatter API Resources
List of Groups
Resource
/chatter/groups/
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
pageSize
q
Type
Integer
Integer
String
Description
An integer specifying a page of items.
The default value is 0, which returns
the first page.
Specifies the number of items per page.
Valid values are between 1 and 250.
The default value is 25.
Specifies the string to search. The
search string must contain at least two
characters, not including any wildcards.
For more information about wildcards,
see Using Wildcards.
Response body
Group Page
Example response body
"currentPageUrl": "/services/data/v27.0/chatter/groups",
"groups": [
{
"canHaveChatterGuests": false,
"community": null
"description": "Get company announcements and other important updates",
"fileCount": 0,
"id": "0F9D00000000FG0KAM",
"lastFeedItemPostDate": "2011-09-21T19:58:58.000Z",
"memberCount": 2,
"motif": {
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},
"myRole": "GroupOwner",
"mySubscription": {
"id": "0FBD00000002oJVOAY",
"url": "/services/data/v27.0/chatter/group-memberships/0FBD00000002oJVOAY"
},
"name": "All Seattle Apps",
102

Chatter API Resources
Group Information
"owner": {
"companyName": "Seattle Apps",
"firstName": "Marion",
"id": "005D0000001Kl6xIAC",
"isActive": true,
"lastName": "Raven",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Marion Raven",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T"
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001Kl6xIAC",
"userType: "Internal"
},
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDQ/F",
"photoVersionId": "729D00000000BDQ",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDQ/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"type": "CollaborationGroup",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000FG0KAM",
"visibility": "PublicAccess"
}],
"nextPageUrl": null,
"previousPageUrl": null
Group Information
Returns information about the specified group.
Resource
/chatter/groups/groupId
103

Chatter API Resources
Group Information
Available since version
23.0
HTTP methods
GET or HEAD
Response body
Group
Example response body
{
"canHaveChatterGuests": false,
"community": null,
"description": "Get company announcements and other important updates",
"fileCount": 0,
"id": "0F9D00000000HRRKA2",
"lastFeedItemPostDate": "2012-06-05T20:36:51.000Z",
"memberCount": 1,
"motif": {
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},
"myRole": "GroupOwner",
"mySubscription": {
"id": "0FBD00000002tgWOAQ",
"url": "/services/data/v27.0/chatter/group-memberships/0FBD00000002tgWOAQ"
},
"name": "All SeattleApps",
"owner": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/005/F",
"photoVersionId": null,
"smallPhotoUrl": "https://instance_name/profilephoto/005/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
104

Chatter API Resources
Batch Group Information
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000JWt/F",
"photoVersionId": "729D00000000JWtIAM",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000JWt/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"type": "CollaborationGroup",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000HRRKA2",
"visibility": "PublicAccess"
Batch Group Information
Returns information about more than one group at the same time.
Resource
/chatter/groups/batch/group_list
Where group_list is a comma separated list of group IDs.
Available since version
23.0
HTTP methods
GET or HEAD
Response body
Batch Results
Group Files
Returns information about the files posted to the specified group.
Resource
/chatter/groups/groupID/files
Available since version
24.0
HTTP methods
GET or HEAD
105

Chatter API Resources
Group Files
Request parameters
Parameter Name
Type
Description
Available Since
page
Integer
An integer specifying a page
of items. The default value
is 0, which returns the first
page.
24.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.
24.0
q
String
A query string to filter the
results. The string must
contain at least two
characters, not including
wildcards. For information
about wildcards, see Using
Wildcards.
27.0
Response body
File Page
Example response body
{
"currentPageUrl": "/services/data/v27.0/chatter/groups/0F9D00000000HwEKAU/files",
"files": [{
"checksum": "a65b71bc6a31fa95dd0a9232c9f58c86",
"contentSize": 100377,
"contentUrl": null,
"description": null,
"downloadUrl":
"/services/data/v27.0/chatter/files/069D00000001E32IAE/content?versionNumber=1",
"fileExtension": "png",
"fileType": "Png",
"flashRenditionStatus": "Na",
"id": "069D00000001E32IAE",
"isInMyFileSynced": false,
"mimeType": "image/png",
"modifiedDate": "2012-07-17T21:47:27.000Z",
"motif": {
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png"
},
"mySubscription": {
"id": "0E8D0000000T5JrKAK",
"url": "/services/data/v27.0/chatter/subscriptions/0E8D0000000T5JrKAK"
},
"name": "Recruitment Poster",
"origin": "Chatter",
"owner": {
"companyName": "SeattleApps",
"firstName": "Rene",
106

Chatter API Resources
Group Members
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile.png",
"smallIconUrl": "/img/icon/profile.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"pdfRenditionStatus": "Na",
"renditionUrl": "/services/data/v27.0/chatter/files/069D00000001E32IAE/rendition",
}
"thumb120By90RenditionStatus": "Success",
"thumb240By180RenditionStatus": "Success",
"thumb720By480RenditionStatus": "Success",
"title": "Recruitment Poster",
"type": "ContentDocument",
"url": "/services/data/v27.0/chatter/files/069D00000001E32IAE?versionNumber=1",
"versionNumber": "1"
}],
"nextPageUrl": null,
"previousPageUrl": null
Group Members
Returns a list of members for the specified group. Also use this resource and POST to add members to a group.
Resource
/chatter/groups/groupId/members
Available since version
23.0
HTTP methods
GET, POST or HEAD
107

Chatter API Resources
Group Members
Request body for POST
Root XML tag
Properties
Name
Type
Description
Available Version
userId
String
The user ID of the member
to be added to the group
23.0
Request parameter for POST
Parameter Name
userId
Type
String
Description
ID of the user to add to the group.
Request parameters for GET or HEAD
Parameter Name
page
pageSize
Type
Integer
Integer
Description
An integer specifying a page of items.
The default value is 0, which returns
the first page.
Specifies the number of items per page.
Valid values are between 1 and 1000.
If you don’t specify a size, the default
is 25.
Response body for GET or HEAD
Group Member Page
Response body for POST
Group Member
Example response body for GET
{
"currentPageUrl": "/services/data/v27.0/chatter/groups/0F9D00000000BsTKAU/members",
"members": [
{
"id": "0FBD00000002kYFOAY",
"role": "GroupOwner",
"url": "/services/data/v27.0/chatter/group-memberships/0FBD00000002kYFOAY",
"user": {
"companyName": "Seattle Apps",
"firstName": "Adam",
108

Chatter API Resources
Group Members
"id": "005D0000001Gl4rIAC",
"isActive": true,
"lastName": "Grant",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Adam Grant",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D000000007ux/F",
"smallPhotoUrl": "https://instance_name/profilephoto/729D000000007ux/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": "Service Engineer",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001Gl4rIAC",
"userType": "Internal"
},
{
"id": "0FBD00000002zClOAI",
"role": "StandardMember",
"url": "/services/data/v27.0/chatter/group-memberships/0FBD00000002zClOAI",
"user": {
"companyName": "Seattle Chatter",
"firstName": "Devi",
"id": "005D0000001GpHpIAK",
"isActive": true,
"lastName": "Tapash",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": {
"id": "005D0000001GpHpIAK",
"url": "/services/data/v27.0/chatter/subscriptions/0E8D00000001VQCKA2"
},
"name": "Devi Tapash",
"photo": {
"fullEmailPhotoUrl":
"https://na1-blitz02.soma.salesforce.cominstance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1i9x6Z16L8wXEGigpcWjAd",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000CSQ/F",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000CSQ/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1q43x_rW2ciXBHst0Eh3Y6",
"url": "/services/data/v27.0/chatter/users/005D0000001LLOBIA4/photo"
},
"title": "Service Engineer",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001GpHpIAK",
"userType": "Internal"
109

Chatter API Resources
Group Members—Private
}
}
}
],
"myMembership": {
"id": "0FBD00000002kYFOAY",
"url": "/services/data/v27.0/chatter/group-memberships/0FBD00000002kYFOAY"
},
"nextPageUrl": null,
"previousPageUrl": null,
"totalMemberCount": 2
Group Members—Private
Request membership in a private group or get the status of requests to a join a private group.
Note: To request membership in a public group use the Group Members resource.
Resource
/chatter/groups/groupId/members/requests
Available since version
27.0
HTTP methods
GET, HEAD, and POST
Request parameter for GET
Parameter Name
Type
Description
Available Since
status
String
Optional. If you include this
parameter, results are filtered
to include those that match
the specified status. Valid
values:
• Accepted
• Declined
• Pending
27.0
Response body for GET or HEAD
Group Membership Request Collection
Response body for POST
Group Membership Request
110

Chatter API Resources
Group Members—Private
This table lists HTTP response code descriptions that are unique to this resource. For descriptions of other HTTP
response codes, see Status Codes and Error Responses.
HTTP Response Code
201
Description
One of the following:
• Success
• User already has a membership request for this group
204
403
User is already a member of this group.
One of the following:
• Group is private: INSUFFICIENT_ACCESS_OR_READONLY
• User is an external user: INSUFFICIENT_ACCESS
Example for GET
This example gets information about all the requests to join that have been accepted for this private group:
/chatter/groups/0F9D00000000izfKAA/members/requests?status=Accepted
The JSON Group Membership Request Collection response body includes one request from the user Gordon Johnson:
{
"requests": [{
"createdDate": "2012-10-19T00:23:23.000Z",
"id": "0I5D000000002fmKAA",
"lastUpdateDate": "2012-10-19T00:24:06.000Z",
"requestedGroup": {
"id": "0F9D00000000izfKAA",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000izfKAA"
},
"responseMessage": null,
"status": "Accepted",
"url": "/services/data/v27.0/chatter/group-membership-requests/0I5D000000002fmKAA",
"user": {
"companyName": "Universal Containers",
"firstName": "Gordon",
"id": "005D0000001LLO1IAO",
"isActive": true,
"lastName": "Johnson",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": {
"id": "0E8D0000000T5ZUKA0",
"url": "/services/data/v27.0/chatter/subscriptions/0E8D0000000T5ZUKA0"
},
"name": "Gordon Johnson",
"photo": {
"fullEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhK
rC7plNhUw5eOz7Aj1u-zWLMxsSybO7lwUPg5_Xne",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/F",
"photoVersionId": "729D00000000LJLIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
111

Chatter API Resources
Group Members—Private
"standardEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0
cPhKrC7plNhUw5eOz7Aj1u_2Vnyzx4jZ2zFiKBz_sTt2",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "VP Sales",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO1IAO",
"userType": "Internal"
}
}],
"total": 1
}
Example for POST
This example requests membership in a private group with the ID 0F9D00000000izfKAA:
/chatter/groups/0F9D00000000izfKAA/members/requests
The Group Membership Request response body is in JSON format:
{
"createdDate": "2012-10-24T00:55:23.000Z",
"id": "0I5D000000002frKAA",
"lastUpdateDate": "2012-10-24T00:55:23.000Z",
"requestedGroup": {
"id": "0F9D00000000j3wKAA",
"url": "/services/data/v27.0
/chatter/groups/0F9D00000000j3wKAA"
},
"responseMessage": null,
"status": "Pending",
"url": "/services/data/v27.0
/chatter/group-membership-requests/0I5D000000002frKAA",
"user": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl": "https://instance_name
/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/
profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/
profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl": "https://instance_name
/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0
/chatter/users/005D0000001LL8OIAW",
112

Chatter API Resources
Group Membership Requests—Private
}
}
"userType": "Internal"
Group Membership Requests—Private
Update the status of a request by a user to join a private group or get information about a request to join a private group. Get
the value of requestId from the Group Membership Request response from a POST request to
/chatter/groups/groupId/members/requests.
Resource
/chatter/group-membership-requests/requestId
Available since version
27.0
HTTP methods
GET, HEAD, and PATCH
Request body for PATCH
Group Membership Request Update
Request parameters for PATCH
Parameter Name
Type
Description
Available Since
responseMessage
String
Use this property to provide a message to the
user if their membership request is declined.
The value of this property is used only when
the value of the status property is
Declined.
27.0
The maximum length is 756 characters.
status
String
Valid values:
• Accepted
• Declined
27.0
Response body for PATCH
Group Membership Request
Response body for GET or HEAD
Group Membership Request
Example for PATCH
This example updates a request to join a private group from Pending to Accepted:
/chatter/group-membership-requests/0I5D000000002fwKAA?status=Accepted
113

Chatter API Resources
Group Photo
This is the JSON Group Membership Request response body:
{
"createdDate": "2012-10-24T16:36:36.000Z",
"id": "0I5D000000002fwKAA",
"lastUpdateDate": "2012-10-24T16:43:57.000Z",
"requestedGroup": {
"id": "0F9D00000000j46KAA",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000j46KAA"
},
"responseMessage": null,
"status": "Accepted",
"url": "/services/data/v27.0/chatter/group-membership-requests/0I5D000000002fwKAA",
"user": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB"
}
}
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
Group Photo
Use this resource to access the photo for the specified group, add, update, or delete the photo.
To add a file from the Files list, use the request body or request parameters in this entry.
To upload a binary file, you must send it in a multipart/form-data message. For information about how to create the
multipart/form-data message, see Uploading Binary Files.
Resource
/chatter/groups/groupId/photo
114

Chatter API Resources
Group Photo
Available since version
23.0
HTTP methods
GET, POST, DELETE, or HEAD
Request body for POST
Describes an existing photo input. To upload a new photo, provide the binary file in a multipart/form-data body
part where name="fileUpload". See Uploading Binary Files.
Root XML tag
Properties
Name
Type
Description
Available Version
fileId
String
18 character Id of an
existing file. The key prefix
must be 069 and the file
size must be less than 2
MB.
25.0
versionNumber
Integer
Version number of an
existing file. If not
provided, the latest version
is used.
25.0
Request parameters for POST
Parameter Name
Type
Description
Available Version
fileId
String
18 character ID of an
existing file. The key prefix
must be 069 and the file size
must be less than 2 MB.
25.0
versionNumber
Integer
Version number of the
existing content. If not
provided, the latest version
is used.
25.0
Note: Photos are processed asynchronously and may not be visible right away.
Response body for GET or HEAD
Photo
115

Chatter API Resources
Group Settings
Response body for POST
Photo
Group Settings
Information about the context user’s Chatter settings for the specified group.
Resource
/chatter/groups/groupId/my-settings
Available since version
27.0
HTTP methods
GET, HEAD, or PATCH
Request body for PATCH
Root XML tag
Properties
A user’s Chatter settings.
Name
emailFrequency
Type
String
Description
The frequency with which a group
member receives email from a group.
Valid values are:
• EachPost
• DailyDigest
• WeeklyDigest
• Never
Available
Version
27.0
Request parameter for PATCH
Parameter Name
Type
Description
Available Since
emailFrequency
String
The frequency with which a
group member receives email
from a group. Valid values
are:
• EachPost
• DailyDigest
• WeeklyDigest
27.0
116

Chatter API Resources
Influence Resource
Parameter Name
Type
Description
Available Since
• Never
Response body for GET, HEAD, or PATCH
Group Chatter Settings
Influence Resource
List of the percentile thresholds used to categorize an organization’s users by their influence in Chatter. Users are ranked
based on the number of posts and comments made, and comments and likes received. The percentile associated with a category
represents the bottom threshold for that influencer category. For example: 0.25 defines the cutoff for the Active Influencer
category, which means it includes users with an influence rank equal to or greater than the 25th percentile (25%) and less than
the next highest category threshold.
Influence Thresholds
Resource
/chatter/influence/thresholds
Available since version
24.0
HTTP method
GET or HEAD
Response body
Influence Thresholds
Example response body
{"thresholds": [
{
"name": "Top Influencer",
"threshold": "0.8",
}
{
"name": "Active Influencer",
"threshold": "0.25",
}
{
"name": "Observer",
"threshold": "0.0",
}
]}
117

Chatter API Resources
Likes Resource
Likes Resource
Information about the specified like. Also used to delete a like.
You can find the ID for a specific like from any feed, such as a news feed or a record feed.
Like
Resource
/chatter/likes/likeId
Available since version
23.0
HTTP methods
GET, DELETE or HEAD
Response body for GET or HEAD
Like
Example response body
{
"id": "0I0D000000003KeKAI",
"likedItem": {
"id": "0D5D0000000IPZuKAO",
"url": "/services/data/v27.0/chatter/feed-items/0D5D0000000IPZuKAO"
},
"url": "/services/data/v27.0/chatter/likes/0I0D000000003KeKAI",
"user": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
118

Chatter API Resources
Motifs Resources
}
}
"userType": "Internal"
Motifs Resources
Returns URLs for sets of small, medium, and large motif icons. Records have different sets of motif icons depending on the
record type.
Available resources are:
Resource
/connect/motifs/idOrPrefix
/connect/motifs/batch/idOrPrefixList
Description
Returns a set of small, medium, and large motif icons for the
specified record.
Returns a set of small, medium, and large motif icons for the
specified records.
Motifs Resource
Returns a set of small, medium, and large motif icons for the specified record.
Specify either an ID or key prefix for idOrPrefix.
Resource
/connect/motifs/idOrPrefix
Available since release
27.0
HTTP methods
GET or HEAD
Response body
Motif
Example of GET
Request for user motifs: /connect/motifs/005D0000001LLO1
Response:
{
}
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
119

Chatter API Resources
News Feed Resources
Batch Motifs Resource
Returns a set of small, medium, and large motif icons for the specified records.
Specify a comma-separated list of IDs and key prefixes for idOrPrefixList. You can mix IDs and key prefixes in the same
request.
Resource
/connect/motifs/batch/idOrPrefixList
Available since release
27.0
HTTP methods
GET or HEAD
Response body
Batch Results
Example of GET
Request for motifs for a user and a file: /connect/motifs/batch/005D0000001LLO1,069D00000001FHF
Response:
{"results": [
{
"result": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"statusCode": 200
},
{
"result": {
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png"
},
"statusCode": 200
}
]}
News Feed Resources
The news feed of the current user. It is made up of items that are of interest to the current user. You can also use the feed-items
resource to add feed-items.
Note: The composition of this feed may change between releases in order to match the feed displayed in Chatter.
Available resources are:
120

Chatter API Resources
News Feed Resources
Resource
/chatter/feeds/news/me
/chatter/feeds/news/me/is-modified
/chatter/feeds/news/me/feed-items
Description
Returns a URL to the feed-items for all feeds for the logged–in
user. Also returns an Is-Modified resource for polling the feed
for updates.
Returns information about whether the news feed has been
updated or changed since the specified time and date.
Returns all feed items from all groups the logged-in user either
owns or is a member of, as well as all files, records, and users
the logged-in user follows. You can also use this resource to
post feed-items.
News Feed URL
Returns a URL to the feed-items for all feeds for the logged–in user. Also returns an Is-Modified resource for polling the feed
for updates.
Resource
/chatter/feeds/news/me
or
/chatter/feeds/news/userId
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
Request parameter
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed
121

Chatter API Resources
News Feed Resources
Example response body
{
"feedItemsUrl":
"/services/data/v27.0/chatter/feeds/news/005xx000001Sv1mAAB/feed-items",
"isModifiedUrl":
"/services/data/v27.0/chatter/feeds/news/005xx000001Sv1mAAB/is-modified?since=2%3A1344352279000"
}
News Feed Is-Modified
Returns information about whether the news feed has been updated or changed since the specified time and date.
Note: Though the Is-Modified resource is generally available, your organization may not have permission to use it
automatically. If you can’t access this resource, contact your salesforce.com representative and ask about the “Enabled
Chatter Feed Polling” permission.
Before the introduction of the Is-Modified resource, you had to poll the news feed directly using the News Feed Items resource,
then do a comparison to see if the news feed had changed. Retrieving a news feed is a costly use of computing resources. In
addition, when you poll a feed directly, you run a greater risk of exceeding the rate limit imposed by Chatter API.
If your application polls the news feed directly, we recommend that you adapt your code to use the Is-Modified resource to
lessen your chances of reaching the rate limit and to save computing resources.
Note: If you are working with remote organizations as an ISV, use the Organization resource and the feedPolling
property of the Feature response body to shape your polling strategy. If feedPolling is not enabled, be conservative
in how often you poll for new content.
Use the Is-Modified resource to poll the news feed
1. Use either of the following resources to get the latest items from a news feed or to get information about the feed:
/chatter/feeds/news/me/feed-items, /chatter/feeds/news/me.
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.
Note that 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. Note
that 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 Items 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.
Note: We don’t recommend exceeding one poll per minute.
122

Chatter API Resources
News Feed Resources
Resource
/chatter/feeds/news/me/is-modified
or
/chatter/feeds/news/userId/is-modified
Note: userId must be the same as the logged-in user.
Available since version
26.0
HTTP methods
GET or HEAD
Request parameter
Parameter Name
since
Type
Required. String.
Description
An opaque token containing
information about the last modified
date of the feed.
Do not construct this token. Retrieve
this token from the
isModifiedToken property of the
Feed Item Page or Feed Modified Info
response body.
Response body
Feed Modified Info
News Feed Items
Returns all feed items from all groups the logged-in user either owns or is a member of, as well as all files, records, and users
the logged-in user follows. You can also use this resource to post feed-items.
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.
GET requests for this resource return the isModifiedUrl property, which contains a News Feed Is-Modified resource for
polling the feed for updates.
123

Chatter API Resources
News Feed Resources
Resource
/chatter/feeds/news/me/feed-items
or
/chatter/feeds/news/userId/feed-items
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET, POST, or HEAD
Request body for POST
Root XML tag
JSON
The following example attaches a poll to a feed item:
{ "attachment":
{
"attachmentType":"Poll",
"pollChoices": [
"Monday",
"Tuesday"
]
},
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning?"
}
]
}
}
Properties
Name
attachment
Type
Depends on type
Description
Optional. You can specify only one of
these values in the attachment parameter.
Values are:
• Attachment Input: Existing Content
(v23.0)
Available
Version
124

Chatter API Resources
News Feed Resources
Name
Type
Description
• Attachment Input: Feed Poll (v26.0)
• Attachment Input: Link (v23.0)
• Attachment Input: New File Upload
(v23.0)
Note: To upload a new file,
you must include it in a
multipart/form–data
message. See Uploading
Binary Files.
Available
Version
body
isBookmarkedByCurrentUser
originalFeedItemId
Message Body Input
Boolean
String
Description of message body
Optional. Specifies if the new feed item
should be bookmarked for the user
(true) or not (false). Default value is
false.
Optional. If this feed item is shared, this
is the original feed item 18-character Id
Note: 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.
23.0
24.0
24.0
visibility
String
Optional. Who can see the post. Valid
values are:
• InternalUsers
• AllUsers
26.0
Note: Portal users in
communities still won’t see
posts with AllUsers specified.
Also see Record Feed Items for more
information about visibility
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
125

Chatter API Resources
News Feed Resources
Parameter Name
Type
Description
Required or Optional
Since
Version
attachmentType
String
The attachment type. Must contain
the value ExistingContent.
Required
27.0
contentDocumentId
String
ID of an existing file.
Required
23.0
text
String
Text of the feed item.
Optional
23.0
isBookmarkedByCurrentUser
String
Specifies if the new feed item should
be bookmarked for the user (true) or
not (false). Default value is false.
Optional
26.0
visibility
String
Who can see the post. Valid values are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t see
posts with AllUsers
specified.
Also see Record Feed-Items for more
information about visibility.
Parameters for attaching a new file
Parameter Name
Type
Description
Required or Optional
Since
Version
attachmentType
String
The attachment type. Must contain
the value NewFile.
Required
27.0
desc
String
Description of file being posted.
Optional
23.0–26.0
Attention: This
parameter should not
be used as of version
27.0. Use
description
instead.
description
String
Description of file being posted.
Optional
27.0
fileName
String
File name of the file being posted.
Required
23.0–24.0
Attention: This
parameter should not
be used as of version
24.0. Use title
instead.
126

Chatter API Resources
News Feed Resources
Parameter Name
Type
Description
Required or Optional
Since
Version
isBookmarkedByCurrentUser
String
Specifies if the new feed item should
be bookmarked for the user (true) or
not (false). Default value is false.
Optional
26.0
text
String
Text of the feed item.
Optional
23.0
title
String
File name of a file to be uploaded and
posted.
Required
24.0
visibility
String
Who can see the post. Valid values are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t see
posts with AllUsers
specified.
Also see Record Feed-Items for more
information about visibility.
Parameters for posting a link
Parameter Name
Type
Description
Required or Optional
Since
version
attachmentType
String
The attachment type. Must
contain the value Link.
Required
27.0
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the
user (true) or not (false).
Default value is false.
Optional
26.0
text
String
Text of the feed item.
Optional
23.0
url
String
URL of the link.
Required
23.0
urlName
String
Name of the URL.
Optional
23.0
visibility
String
Who can see the post. Valid
values are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t
see posts with
AllUsers specified.
127

Chatter API Resources
News Feed Resources
Parameter Name
Type
Description
Required or Optional
Since
version
Also see Record Feed-Items for
more information about
visibility.
Parameters for posting a poll
Parameter Name
Type
Description
Required or
Optional
Since
version
attachmentType
String
The attachment type. Must
contain the value Poll.
Required
27.0
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the user
(true) or not (false). Default
value is false.
Optional
26.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
text
String
Text of the feed item.
Required
23.0
visibility
String
Who can see the post. Valid values
are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t
see posts with AllUsers
specified.
Also see Record Feed-Items for
more information about
visibility.
Parameters for sharing a post
Parameter Name
Type
Description
Required or
Optional
Since
Version
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the
user (true) or not (false).
Default value is false.
Optional
26.0
128

Chatter API Resources
News Feed Resources
Parameter Name
Type
Description
Required or
Optional
Since
Version
originalFeedItemId
String
The Id of the feed item you
want to share.18-character Id
Required
24.0
Note: Sharing a post
takes precedence over
uploading a file. Do
not share a post and
upload a file in the
same post.
text
String
Text of the feed item.
Optional
23.0
visibility
String
Who can see the post. Valid
values are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still
won’t see posts with
AllUsers specified.
Also see Record Feed-Items
for more information about
visibility.
Text post parameters
Parameter Name
Type
Description
Required or
Optional
Since
version
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the user
(true) or not (false). Default
value is false.
Optional
26.0
text
String
Text of the feed item.
Required
23.0
visibility
String
Who can see the post. Valid values
are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t
see posts with AllUsers
specified.
129

Chatter API Resources
News Feed Resources
Parameter Name
Type
Description
Required or
Optional
Since
version
Also see Record Feed-Items for
more information about
visibility.
Request parameters for GET or HEAD
Parameter Name
page
Type
String
Description
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:
"nextPageUrl":
"/services/data/v27.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
sort
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
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.
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body for GET or HEAD
Feed Item Page
Response body for POST
Feed Item
Example of file post
The following is an example of updating a news feed with a file post.
curl --form feedItemFileUpload=@/home/ujones/Desktop/FY12_results.ppt
--form title=FY12_results
--form "description=FY 12 SE Division Sales Results"
130

Chatter API Resources
News Feed Resources
--form "text=Please review"
--header 'Authorization: Bearer 00Dx0000000M5Li!ARIAQCZ4DkPlHzGMaYKgVubVN.
K3ztqnibMTXDGDs8zEjbB7wVC6xA0pcfOMFWwJkjmNhNIH5RbVZ722hBeN0VE_c8jNFrAv'
https://instance_name/services/data/v27.0/chatter/feeds/news/me/feed-items
The following is an example in Java of updating a news feed with a file post.
import java.io.File;
import org.apache.commons.httpclient.*;
import org.apache.commons.httpclient.methods.PostMethod;
import org.apache.commons.httpclient.methods.multipart.*;
...
String oauthToken = "00Dx0000000X42V!AQgAQClp6UqGWNJUf4d3LQkVCysBIS6a";
String url = "https://instance_name/services/data/v27.0/chatter/" +
"feeds/user-profile/me/feed-items";
String text = "I love posting files to Chatter!";
File contentFile = getFile();
String description = "This is a test file that I'm posting.";
String title = "contentFile";
Part[] parts = {
new StringPart("description", description),
new StringPart("title", fileName),
new StringPart("text", text),
new FilePart("feedItemFileUpload", contentFile),
};
final PostMethod postMethod = new PostMethod(url);
try {
postMethod.setRequestEntity(new MultipartRequestEntity(parts,
postMethod.getParams()));
postMethod.setRequestHeader("Authorization", "Bearer " + oauthToken);
postMethod.setRequestHeader("Content-type", "multipart/form-data")
postMethod.addRequestHeader("X-PrettyPrint", "1");
HttpClient httpClient = new HttpClient();
httpClient.getParams().setSoTimeout(60000);
int returnCode = httpClient.executeMethod(postMethod);
System.out.println(postMethod.getResponseBodyAsString());
assertTrue("Expected return code of: " + HttpStatus.SC_CREATED,
returnCode == HttpStatus.SC_CREATED);
} finally {
postMethod.releaseConnection();
}
Example of a link post
The following creates a link post using the request parameters:
/chatter/feeds/news/me/feed-items?text=Did+you+see+this?&url=http://www.chatter.com
The following is the request body for creating a link in a feed-item post:
{ "body" : {
"messageSegments" : [
131

Chatter API Resources
News Feed Resources
}
}
]
{
},
{
}
"type": "Link",
"url" : "http://www.chatter.com"
"type": "Text",
"text" : "Is everyone following this?"
The following is the request body for including a link as an attachment to a feed-item post:
{ "body" : {
"messageSegments" : [
{
"type": "Text",
"text" : "Is everyone following this?"
}
]
},
"attachment" :{
"url" : "http://www.chatter.com",
"urlName" : "The Future of Social Enterprise"
}
}
News Feed Items Flat
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
or
/chatter/feeds/news/me/feed-items/flat
/chatter/feeds/news/userId/feed-items/flat
Note: userId must be the same as the logged-in user.
Available since version
25.0
HTTP methods
GET or HEAD
132

Chatter API Resources
News Feed Resources
Request parameters
Parameter Name
numFeedItems
page
recentCommentCount
sort
Type
Integer
String
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
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.
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.
Specifies the number of recent
comments returned. Valid values are
between 0 and 25. Default value is 3.
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
Example response
{
"items" : [ {
"type" : "Comment",
"item" : {
"parent" : {
"id" : "005D0000001L3zVIAS",
"url" : "/services/data/v27.0/chatter/users/005D0000001L3zVIAS"
},
"id" : "0D7D00000000N5rKAE",
"type" : "TextComment",
"user" : {
"name" : "Pierre Delacruix",
"title" : null,
"firstName" : "Pierre",
"lastName" : "Delacruix",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"companyName" : "Seattle Apps",
"mySubscription" : null,
133

Chatter API Resources
People Feed Resources
"photo" : {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1i9x6Z16L8wXEGigpcWjAd",
"largePhotoUrl" : "https://instance_name/profilephoto/729D00000000Fj1/F",
"photoVersionId" : "729D00000000Fj1IAE",
"smallPhotoUrl" : "https://instance_name/profilephoto/729D00000000Fj1/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1q43x_rW2ciXBHst0Eh3Y6",
}
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"isActive" : false,
"id" : "005D0000001L3zVIAS",
"url" : "/services/data/v27.0/chatter/users/005D0000001L3zVIAS",
"type" : "User"
},
"url" : "/services/data/v27.0/chatter/comments/0D7D00000000N5rKAE",
"userType" : "Internal",
"body" : {
"text" : "Time to get working",
"messageSegments" : [ {
"type" : "Text",
"text" : "Time to get working"
} ]
},
"clientInfo" : null,
"createdDate" : "2012-03-18T00:03:20.000Z",
"likes" : {
"total" : 0,
"likes" : [ ],
"nextPageUrl" : null,
"currentPageUrl" : null,
"previousPageUrl" : null
},
"isDeleteRestricted" : false,
"myLike" : null,
"attachment" : null,
"feedItem" : {
"id" : "0D5D0000000HWC2KAO",
"url" : "/services/data/v27.0/chatter/feed-items/0D5D0000000HWC2KAO"
}
People Feed Resources
All feed items posted by all of the people the current user follows.
Available resources are:
Resource
/chatter/feeds/people/me
/chatter/feeds/people/me/feed-items
Description
Returns a URL to the feed-items for all the people the current
user is following.
Returns all the feed items from all the people the current user
follows.
134

Chatter API Resources
People Feed Resources
People Feed URL
Returns a URL to the feed-items for all the people the current user is following.
Resource
/chatter/feeds/people/me
or
/chatter/feeds/people/userId
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed
People Feed Items
Returns all the feed items from all the people the current user follows.
Resource
/chatter/feeds/people/me/feed-items
or
/chatter/feeds/people/userId/feed-items
Note: userId must be the same as the logged-in user.
135

Chatter API Resources
People Feed Resources
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
Type
String
Description
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:
"nextPageUrl":
"/services/data/v27.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
sort
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
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.
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed Item Page
People Feed Items Flat
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
/chatter/feeds/people/me/feed-items/flat
136

Chatter API Resources
People Feed Resources
or
/chatter/feeds/people/userId/feed-items/flat
Note: userId must be the same as the logged-in user.
Available since version
25.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
numFeedItems
page
recentCommentCount
sort
Type
Integer
String
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
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.
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.
Specifies the number of recent
comments returned. Valid values are
between 0 and 25. Default value is 3.
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
137

Chatter API Resources
Record Feed Resource
Record Feed Resource
The feed of the specified record, which could be a group, person, object, file and so on.
Available resources are:
Resource
/chatter/feeds/record/me
/chatter/feeds/record/me/feed-items
Description
Returns a URL to the feed-items for all the records the current
user is following, or a URL to all the feed-items of the
specified recordId.
Returns the feed-items for all the records the current, signed-in
user is following, or all the feed-items of the specified
recordId. You can also use this resource to post a new feed
item and to search a group feed.
Record Feed URL
Returns a URL to the feed-items for all the records the current user is following, or a URL to all the feed-items of the specified
recordId.
Resource
/chatter/feeds/record/me
or
/chatter/feeds/record/recordId
Note: If recordId is a user ID, it must be the same as the current user.
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
138

Chatter API Resources
Record Feed Resource
Response body
Feed
Record Feed Items
Returns the feed-items for all the records the current, signed-in user is following, or all the feed-items of the specified recordId.
You can also use this resource to post a new feed item and to search a group feed.
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.
The visibility parameter is available for posting to most feeds. However, only the Record Feed-Items resource can specify
the value InternalUsers, and only when the record is not a user or a group. All other resources, if you specify the
visibility parameter, you must use AllUsers. In addition, portal users cannot specify InternalUsers, as they wouldn’t
be able to see the post. In general, for posts not to a user or group, the default value for visibility matches the logged-in user
who is posting: internal users post with a visibility of InternalUsers, while portal users post with the visibility of AllUsers.
Resource
or
/chatter/feeds/record/me/feed-items
/chatter/feeds/record/recordId/feed-items
Note: If recordId is a user ID, it must be the same as the current user.
Available since version
23.0
HTTP methods
GET, POST or HEAD
Request body for POST
Root XML tag
JSON
The following example attaches a poll to a feed item:
{ "attachment":
{
"attachmentType":"Poll",
"pollChoices": [
"Monday",
"Tuesday"
]
139

Chatter API Resources
Record Feed Resource
}
},
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning?"
}
]
}
Properties
Name
attachment
Type
Depends on type
Description
Optional. You can specify only one of
these values in the attachment parameter.
Values are:
• Attachment Input: Existing Content
(v23.0)
• Attachment Input: Feed Poll (v26.0)
• Attachment Input: Link (v23.0)
• Attachment Input: New File Upload
(v23.0)
Note: To upload a new file,
you must include it in a
multipart/form–data
message. See Uploading
Binary Files.
Available
Version
body
isBookmarkedByCurrentUser
originalFeedItemId
Message Body Input
Boolean
String
Description of message body
Optional. Specifies if the new feed item
should be bookmarked for the user
(true) or not (false). Default value is
false.
Optional. If this feed item is shared, this
is the original feed item 18-character Id
Note: 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.
23.0
24.0
24.0
140

Chatter API Resources
Record Feed Resource
Name
Type
Description
Available
Version
visibility
String
Optional. Who can see the post. Valid
values are:
• InternalUsers
• AllUsers
26.0
Note: Portal users in
communities still won’t see
posts with AllUsers specified.
Also see Record Feed Items for more
information about visibility
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
Since
Version
attachmentType
String
The attachment type. Must contain
the value ExistingContent.
Required
27.0
contentDocumentId
String
ID of an existing file.
Required
23.0
text
String
Text of the feed item.
Optional
23.0
isBookmarkedByCurrentUser
String
Specifies if the new feed item should
be bookmarked for the user (true) or
not (false). Default value is false.
Optional
26.0
visibility
String
Who can see the post. Valid values are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t see
posts with AllUsers
specified.
Also see Record Feed-Items for more
information about visibility.
Parameters for attaching a new file
141

Chatter API Resources
Record Feed Resource
Parameter Name
Type
Description
Required or Optional
Since
Version
attachmentType
String
The attachment type. Must contain
the value NewFile.
Required
27.0
desc
String
Description of file being posted.
Optional
23.0–26.0
Attention: This
parameter should not
be used as of version
27.0. Use
description
instead.
description
String
Description of file being posted.
Optional
27.0
fileName
String
File name of the file being posted.
Required
23.0–24.0
Attention: This
parameter should not
be used as of version
24.0. Use title
instead.
isBookmarkedByCurrentUser
String
Specifies if the new feed item should
be bookmarked for the user (true) or
not (false). Default value is false.
Optional
26.0
text
String
Text of the feed item.
Optional
23.0
title
String
File name of a file to be uploaded and
posted.
Required
24.0
visibility
String
Who can see the post. Valid values are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t see
posts with AllUsers
specified.
Also see Record Feed-Items for more
information about visibility.
Parameters for posting a link
Parameter Name
Type
Description
Required or Optional
Since
version
attachmentType
String
The attachment type. Must
contain the value Link.
Required
27.0
142

Chatter API Resources
Record Feed Resource
Parameter Name
Type
Description
Required or Optional
Since
version
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the
user (true) or not (false).
Default value is false.
Optional
26.0
text
String
Text of the feed item.
Optional
23.0
url
String
URL of the link.
Required
23.0
urlName
String
Name of the URL.
Optional
23.0
visibility
String
Who can see the post. Valid
values are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t
see posts with
AllUsers specified.
Also see Record Feed-Items for
more information about
visibility.
Parameters for posting a poll
Parameter Name
Type
Description
Required or
Optional
Since
version
attachmentType
String
The attachment type. Must
contain the value Poll.
Required
27.0
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the user
(true) or not (false). Default
value is false.
Optional
26.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
text
String
Text of the feed item.
Required
23.0
visibility
String
Who can see the post. Valid values
are:
• InternalUsers
• AllUsers
Optional
26.0
143

Chatter API Resources
Record Feed Resource
Parameter Name
Type
Description
Required or
Optional
Since
version
Note: Portal users in
communities still won’t
see posts with AllUsers
specified.
Also see Record Feed-Items for
more information about
visibility.
Parameters for sharing a post
Parameter Name
Type
Description
Required or
Optional
Since
Version
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the
user (true) or not (false).
Default value is false.
Optional
26.0
originalFeedItemId
String
The Id of the feed item you
want to share.18-character Id
Required
24.0
Note: Sharing a post
takes precedence over
uploading a file. Do
not share a post and
upload a file in the
same post.
text
String
Text of the feed item.
Optional
23.0
visibility
String
Who can see the post. Valid
values are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still
won’t see posts with
AllUsers specified.
Also see Record Feed-Items
for more information about
visibility.
Text post parameters
144

Chatter API Resources
Record Feed Resource
Parameter Name
Type
Description
Required or
Optional
Since
version
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the user
(true) or not (false). Default
value is false.
Optional
26.0
text
String
Text of the feed item.
Required
23.0
visibility
String
Who can see the post. Valid values
are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t
see posts with AllUsers
specified.
Also see Record Feed-Items for
more information about
visibility.
Request parameters for GET or HEAD
Parameter
Name
page
pageSize
q
sort
Type
Token
Integer
String
Description
A generated token that
indicates the view of feed
items in the feed.
Required or
Optional
Optional
Specifies the number of items Optional
per page. Valid values are
between 1 and 100. If you
don't specify a size, the default
is 25.
Search for one or more Optional
keywords in the body and
comment of feed items in a
record feed. The search string
can contain wildcards and
must contain at least two
characters that aren’t
wildcards. See Using
Wildcards..
String. One of the following: Sorts the feed items by most
• CreatedDateDesc recent post date
• LastModifiedDateDesc (CreatedDateDesc) or by
most recent activity
Optional
Since version
23.0
23.0
27.0
23.0
145

Chatter API Resources
Record Feed Resource
Parameter
Name
Type
Description
Required or
Optional
Since version
(LastModifiedDateDesc).
Activity includes posts and
comments. The default is
CreatedDateDesc.
Response body for GET or HEAD
Feed Item Page
Response body for POST
Feed Item
Example response body for POST
{
"currentPageUrl":
"/services/data/v27.0/chatter/feeds/record/005D0000001LL8OIAW/feed-items",
"isModifiedToken": null,
"isModifiedUrl": null,
"items": [
{
"actor": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
},
"attachment": {
"description": null,
"icon": null,
"linkUrl": "null",
146

Chatter API Resources
Record Feed Resource
"subtype": "CollaborationGroupCreated",
"title": null,
"type": "BasicTemplate"
},
"body": {
"messageSegments": [
{
"text": "created the public group ",
"type": "Text"
},
{
"motif": {
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},
"reference": {
"id": "0F9D00000000I1dKAE",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000I1dKAE"
},
"text": "All Seattle Apps",
"type": "EntityLink"
},
{
"text": ".",
"type": "Text"
}
],
"text": "created the public group All Seattle Apps."
},
"canShare": false,
"clientInfo": null,
"comments": {
"comments": [],
"currentPageUrl":
"/services/data/v27.0/chatter/feed-items/0D5D0000000Hw6oKAC/comments",
"nextPageUrl": null,
"total": 0
},
"createdDate": "2012-09-07T04:19:17.000Z",
"event": false,
"id": "0D5D0000000Hw6oKAC",
"isBookmarkedByCurrentUser": false,
"isDeleteRestricted": true,
"isLikedByCurrentUser": false,
"likes": {
"currentPageUrl":
"/services/data/v27.0/chatter/feed-items/0D5D0000000Hw6oKAC/likes",
"likes": [],
"nextPageUrl": null,
"previousPageUrl": null,
"total": 0
},
"likesMessage": null,
"modifiedDate": "2012-09-07T04:19:17.000Z",
"myLike": null,
"originalFeedItem": null,
"originalFeedItemActor": null,
"parent": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
147

Chatter API Resources
Record Feed Resource
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB",
},
{
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
},
"photoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"preamble": {
"messageSegments": [{
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"reference": {
"id": "005D0000001LL8OIAW",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW"
},
"text": "Deanna Li",
"type": "EntityLink"
}],
"text": "Deanna Li"
},
"topics": null,
"type": "BasicTemplateFeedItem",
"url": "/services/data/v27.0/chatter/feed-items/0D5D0000000Hw6oKAC",
"visibility": "AllUsers"
"actor": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
148

Chatter API Resources
Record Feed Resource
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
},
"attachment": {
"description": null,
"icon": null,
"linkUrl": "null",
"subtype": "CollaborationGroupCreated",
"title": null,
"type": "BasicTemplate"
},
"body": {
"messageSegments": [
{
"text": "created the public group ",
"type": "Text"
},
{
"motif": {
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},
"reference": {
"id": "0F9D00000000I1YKAU",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000I1YKAU"
},
"text": "All Universal Containers",
"type": "EntityLink"
},
{
"text": ".",
"type": "Text"
}
],
"text": "created the public group All Universal Containers."
},
"canShare": false,
"clientInfo": null,
"comments": {
"comments": [],
"currentPageUrl":
"/services/data/v27.0/chatter/feed-items/0D5D0000000Hw6jKAC/comments",
"nextPageUrl": null,
"total": 0
},
"createdDate": "2012-09-07T04:18:34.000Z",
"event": false,
"id": "0D5D0000000Hw6jKAC",
"isBookmarkedByCurrentUser": false,
"isDeleteRestricted": true,
"isLikedByCurrentUser": false,
"likes": {
"currentPageUrl":
"/services/data/v27.0/chatter/feed-items/0D5D0000000Hw6jKAC/likes",
"likes": [],
149

Chatter API Resources
Record Feed Resource
"nextPageUrl": null,
"previousPageUrl": null,
"total": 0
},
"likesMessage": null,
"modifiedDate": "2012-09-07T04:18:34.000Z",
"myLike": null,
"originalFeedItem": null,
"originalFeedItemActor": null,
"parent": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saBc65JKjmm4DaxyLRr1XQK",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZNDZe0BfzuOg1WyB6Vo-DB",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
},
"photoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"preamble": {
"messageSegments": [{
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"reference": {
"id": "005D0000001LL8OIAW",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW"
},
"text": "Deanna Li",
"type": "EntityLink"
}],
"text": "Deanna Li"
},
"topics": null,
"type": "BasicTemplateFeedItem",
"url": "/services/data/v27.0/chatter/feed-items/0D5D0000000Hw6jKAC",
"visibility": "AllUsers"
}
],
"nextPageUrl": null
150

Chatter API Resources
Record Feed Resource
Example for GET
This request searches for feed items that contain the string track:
/chatter/feeds/record/me/feed-items?q=track
In the Feed Item Page response body, the string track is found in the feed-items/items/body/text property:
{
"currentPageUrl":
"/services/data/v27.0/chatter/feeds/record/005D0000001LL8OIAW/feed-items",
"isModifiedToken": null,
"isModifiedUrl": null,
"items": [{
"actor": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5savQXz9sPZRCJJB7fC4UIka",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saluKolvB94ZwqX5yHBSBOh",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
},
"attachment": null,
"body": {
"messageSegments": [{
"text": "I'm building an app to track "floater" holidays.
Does anyone have any feature requests?",
"type": "Text"
}],
"text": "I'm building an app to track "floater" holidays.
Does anyone have any feature requests?"
},
"canShare": true,
"clientInfo": null,
"comments": {
"comments": [],
"currentPageUrl":
"/services/data/v27.0/chatter/feed-items/0D5D0000000HwkyKAC/comments",
"nextPageUrl": null,
"total": 4
},
"createdDate": "2012-09-12T00:54:27.000Z",
151

Chatter API Resources
Record Feed Resource
"event": false,
"id": "0D5D0000000HwkyKAC",
"isBookmarkedByCurrentUser": false,
"isDeleteRestricted": false,
"isLikedByCurrentUser": false,
"likes": {
"currentPageUrl":
"/services/data/v27.0/chatter/feed-items/0D5D0000000HwkyKAC/likes",
"likes": [],
"nextPageUrl": null,
"previousPageUrl": null,
"total": 0
},
"likesMessage": null,
"modifiedDate": "2012-09-12T01:01:42.000Z",
"myLike": null,
"originalFeedItem": null,
"originalFeedItemActor": null,
"parent": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5savQXz9sPZRCJJB7fC4UIka",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saluKolvB94ZwqX5yHBSBOh",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
},
"photoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"preamble": {
"messageSegments": [{
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"reference": {
"id": "005D0000001LL8OIAW",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW"
},
"text": "Deanna Li",
"type": "EntityLink"
}],
"text": "Deanna Li"
},
"topics": null,
152

Chatter API Resources
Record Feed Resource
}
"type": "TextPost",
"url": "/services/data/v27.0/chatter/feed-items/0D5D0000000HwkyKAC",
"visibility": "AllUsers"
}],
"nextPageUrl": null
Record Feed Items Flat
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
/chatter/feeds/record/me/feed-items/flat
or
/chatter/feeds/record/userId/feed-items/flat
Note: userId must be the same as the logged-in user.
Available since version
25.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
numFeedItems
page
Type
Integer
String
Description
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.
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.
153

Chatter API Resources
Records Resources
Parameter Name
recentCommentCount
sort
Type
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Specifies the number of recent
comments returned. Valid values are
between 0 and 25. Default value is 3.
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
See Also:
Records Resources
Records Resources
Information about the specified record, including followers.
Note: This is not a feed. To obtain a feed for a record, use the Record Feed Resource.
Available resources are:
Resource
/chatter/records/recordId
/chatter/records/recordId/followers
Description
Returns information about the specific record, such as the
name of the record, the record type, a URL to the feed-items
for the record, and so on.
Returns information about the followers of the specified
record.
Record Information
Returns information about the specific record, such as the name of the record, the record type, a URL to the feed-items for
the record, and so on.
Resource
/chatter/records/recordId
Available since version
23.0
154

Chatter API Resources
Records Resources
HTTP methods
GET or HEAD
Response body
Record Summary
Example response body
{
}
"id": "069D00000001FHFIA2",
"motif": {
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png"
},
"mySubscription": {
"id": "0E8D0000000T5fwKAC",
"url": "/services/data/v27.0/chatter/subscriptions/0E8D0000000T5fwKAC"
},
"name": "sales",
"type": "ContentDocument",
"url": "/services/data/v27.0/chatter/files/069D00000001FHFIA2"
Record Followers
Returns information about the followers of the specified record.
Resource
/chatter/records/recordId/followers
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
pageSize
Type
Integer
Integer
Description
An integer specifying a page of items.
The default value is 0, which returns
the first page.
Specifies the number of items per page.
Valid values are between 1 and 1000.
If you don't specify a size, the default
is 25.
155

Chatter API Resources
Subscriptions Resource
Response body
Subscription Page
See Also:
Record Feed Resource
Subscriptions Resource
Information about the specified subscription. Also used to delete a subscription, for example, to unfollow a record. A subscription
ID is returned as part of the response body for follower and following resources, for example,
/records/recordId/followers. In addition, subscriptions IDs are also returned in many summary response bodies, such
as group summary or user summary.
Resource
/chatter/subscriptions/subscriptionId
Available since version
23.0
HTTP methods
GET, DELETE, or HEAD
Response body for GET or HEAD
Subscription
Example response body for GET
{
"community": null,
"id": "0E8D0000000T5ZUKA0",
"subject": {
"companyName": "Universal Containers",
"firstName": "Gordon",
"id": "005D0000001LLO1IAO",
"isActive": true,
"lastName": "Johnson",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": {
"id": "0E8D0000000T5ZUKA0",
"url": "/services/data/v27.0/chatter/subscriptions/0E8D0000000T5ZUKA0"
},
"name": "Gordon Johnson",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u91Xc_BCo43jyG-NY5CSIcR",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/F",
"photoVersionId": "729D00000000LJLIA2",
156

Chatter API Resources
To Feed Resources
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-3RD3PFAzXpfnjWrX0_Inp",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "VP Sales",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO1IAO",
"userType": "Internal"
},
"subscriber": {
"companyName": "Universal Containers",
"firstName": "Deanna",
"id": "005D0000001LL8OIAW",
"isActive": true,
"lastName": "Li",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Deanna Li",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5savQXz9sPZRCJJB7fC4UIka",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/F",
"photoVersionId": "729D00000000LJFIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJF/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5saluKolvB94ZwqX5yHBSBOh",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW",
"userType": "Internal"
},
"url": "/services/data/v27.0/chatter/subscriptions/0E8D0000000T5ZUKA0"
To Feed Resources
Feed of all @mentions of the current user and posts others make to the logged-in user's feed.
Available resources are:
Resource
/chatter/feeds/to/me
/chatter/feeds/to/me/feed-items
Description
Returns a URL to the feed-items for the feed of the logged-in
user.
Returns the feed-items for all @mentions of the logged-in
user, and all posts made to the user's feed.
157

Chatter API Resources
To Feed Resources
To Feed URL
Returns a URL to the feed-items for the feed of the logged-in user.
Resource
/chatter/feeds/to/me
OR
/chatter/feeds/to/userId
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed
To Feed Items
Returns the feed-items for all @mentions of the logged-in user, and all posts made to the user's feed. The To Feed includes
posts that mention you and posts that other users make to your wall. Your own posts are included only if they have a comment.
The comment can be from you or from another user.
Resource
/chatter/feeds/to/me/feed-items
OR
/chatter/feeds/to/userId/feed-items
158

Chatter API Resources
To Feed Resources
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
Response body for GET or HEAD
Feed Item Page
To Feed Items Flat
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
/chatter/feeds/to/me/feed-items/flat
or
/chatter/feeds/to/userId/feed-items/flat
Note: userId must be the same as the logged-in user.
Available since version
25.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
numFeedItems
Type
Integer
Description
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.
159

Chatter API Resources
Topics Resource
Parameter Name
page
recentCommentCount
sort
Type
String
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
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.
Specifies the number of recent
comments returned. Valid values are
between 0 and 25. Default value is 3.
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
Topics Resource
Trending Topics
List of the trending hashtag topics for the organization.
Resource
/chatter/topics/trending
Available since version
24.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
maxResults
Values
Integer
Description
Maximum number of trending topics
that get returned. The default is 5.
Value must be greater than 0 and less
than 100.
160

Chatter API Resources
User-Profile Feed Resources
Response body
Topics
Example response body
{"topics" : [
{
"name" : "#UniversalPaper"
},
{
"name" : "#caseUpdates"
},
{
"name" : "#salesTips"
},
{
"name" : "#companypicnic"
},
{
"name" : "#AccountExecs"
}
]}
User-Profile Feed Resources
Feed of actions by the current user on records that can be tracked in a feed. This is different than/chatter/feeds/news,
which returns more items, including posts, group updates, and record updates. You can also post feed items to the user-profile
feed.
Note: The composition of this feed may change between releases in order to match the feed displayed in Chatter.
Available resources are:
Resource
/chatter/feeds/user-profile/me
/chatter/feeds/user-profile/me/feed-items
Description
Returns a URL to the feed-items for the user-profile feed.
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.
User–Profile Feed URL
Returns a URL to the feed-items for the user-profile feed.
Resource
or
/chatter/feeds/user-profile/me
/chatter/feeds/user-profile/userId
161

Chatter API Resources
User-Profile Feed Resources
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
sort
Type
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body
Feed
User–Profile Feed Items
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.
Resource
or
/chatter/feeds/user-profile/me/feed-items
/chatter/feeds/user-profile/userId/feed-items
Available since version
23.0
HTTP methods
GET, POST or HEAD
Request body for POST
Root XML tag
162

Chatter API Resources
User-Profile Feed Resources
JSON
The following example attaches a poll to a feed item:
{ "attachment":
{
"attachmentType":"Poll",
"pollChoices": [
"Monday",
"Tuesday"
]
},
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning?"
}
]
}
}
Properties
Name
attachment
Type
Depends on type
Description
Optional. You can specify only one of
these values in the attachment parameter.
Values are:
• Attachment Input: Existing Content
(v23.0)
• Attachment Input: Feed Poll (v26.0)
• Attachment Input: Link (v23.0)
• Attachment Input: New File Upload
(v23.0)
Note: To upload a new file,
you must include it in a
multipart/form–data
message. See Uploading
Binary Files.
Available
Version
body
Message Body Input
Description of message body
23.0
isBookmarkedByCurrentUser
Boolean
Optional. Specifies if the new feed item
should be bookmarked for the user
(true) or not (false). Default value is
false.
24.0
163

Chatter API Resources
User-Profile Feed Resources
Name
originalFeedItemId
Type
String
Description
Optional. If this feed item is shared, this
is the original feed item 18-character Id
Note: 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.
Available
Version
24.0
visibility
String
Optional. Who can see the post. Valid
values are:
• InternalUsers
• AllUsers
26.0
Note: Portal users in
communities still won’t see
posts with AllUsers specified.
Also see Record Feed Items for more
information about visibility
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
Since
Version
attachmentType
String
The attachment type. Must contain
the value ExistingContent.
Required
27.0
contentDocumentId
String
ID of an existing file.
Required
23.0
text
String
Text of the feed item.
Optional
23.0
isBookmarkedByCurrentUser
String
Specifies if the new feed item should
be bookmarked for the user (true) or
not (false). Default value is false.
Optional
26.0
visibility
String
Who can see the post. Valid values are:
• InternalUsers
• AllUsers
Optional
26.0
164

Chatter API Resources
User-Profile Feed Resources
Parameter Name
Type
Description
Required or Optional
Since
Version
Note: Portal users in
communities still won’t see
posts with AllUsers
specified.
Also see Record Feed-Items for more
information about visibility.
Parameters for attaching a new file
Parameter Name
Type
Description
Required or Optional
Since
Version
attachmentType
String
The attachment type. Must contain
the value NewFile.
Required
27.0
desc
String
Description of file being posted.
Optional
23.0–26.0
Attention: This
parameter should not
be used as of version
27.0. Use
description
instead.
description
String
Description of file being posted.
Optional
27.0
fileName
String
File name of the file being posted.
Required
23.0–24.0
Attention: This
parameter should not
be used as of version
24.0. Use title
instead.
isBookmarkedByCurrentUser
String
Specifies if the new feed item should
be bookmarked for the user (true) or
not (false). Default value is false.
Optional
26.0
text
String
Text of the feed item.
Optional
23.0
title
String
File name of a file to be uploaded and
posted.
Required
24.0
visibility
String
Who can see the post. Valid values are:
• InternalUsers
• AllUsers
Optional
26.0
165

Chatter API Resources
User-Profile Feed Resources
Parameter Name
Type
Description
Required or Optional
Since
Version
Note: Portal users in
communities still won’t see
posts with AllUsers
specified.
Also see Record Feed-Items for more
information about visibility.
Parameters for posting a link
Parameter Name
Type
Description
Required or Optional
Since
version
attachmentType
String
The attachment type. Must
contain the value Link.
Required
27.0
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the
user (true) or not (false).
Default value is false.
Optional
26.0
text
String
Text of the feed item.
Optional
23.0
url
String
URL of the link.
Required
23.0
urlName
String
Name of the URL.
Optional
23.0
visibility
String
Who can see the post. Valid
values are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t
see posts with
AllUsers specified.
Also see Record Feed-Items for
more information about
visibility.
Parameters for posting a poll
Parameter Name
Type
Description
Required or
Optional
Since
version
attachmentType
String
The attachment type. Must
contain the value Poll.
Required
27.0
166

Chatter API Resources
User-Profile Feed Resources
Parameter Name
Type
Description
Required or
Optional
Since
version
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the user
(true) or not (false). Default
value is false.
Optional
26.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
text
String
Text of the feed item.
Required
23.0
visibility
String
Who can see the post. Valid values
are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t
see posts with AllUsers
specified.
Also see Record Feed-Items for
more information about
visibility.
Parameters for sharing a post
Parameter Name
Type
Description
Required or
Optional
Since
Version
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the
user (true) or not (false).
Default value is false.
Optional
26.0
originalFeedItemId
String
The Id of the feed item you
want to share.18-character Id
Required
24.0
Note: Sharing a post
takes precedence over
uploading a file. Do
not share a post and
upload a file in the
same post.
text
String
Text of the feed item.
Optional
23.0
167

Chatter API Resources
User-Profile Feed Resources
Parameter Name
Type
Description
Required or
Optional
Since
Version
visibility
String
Who can see the post. Valid
values are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still
won’t see posts with
AllUsers specified.
Also see Record Feed-Items
for more information about
visibility.
Text post parameters
Parameter Name
Type
Description
Required or
Optional
Since
version
isBookmarkedByCurrentUser
String
Specifies if the new feed item
should be bookmarked for the user
(true) or not (false). Default
value is false.
Optional
26.0
text
String
Text of the feed item.
Required
23.0
visibility
String
Who can see the post. Valid values
are:
• InternalUsers
• AllUsers
Optional
26.0
Note: Portal users in
communities still won’t
see posts with AllUsers
specified.
Also see Record Feed-Items for
more information about
visibility.
Request parameters for GET or HEAD
Parameter Name
page
Type
String
Description
A generated token that indicates the
view of feed items in the feed. Page
tokens are returned as part of the
168

Chatter API Resources
User-Profile Feed Resources
Parameter Name
Type
Description
response body, in one of the URL
parameters, such as nextPageURL, for
example:
"nextPageUrl":
"/services/data/v27.0/
chatter/feeds/news/
005D0000001GLowIAN
/feed-items
?page=2011-03-30T17:34:50Z,
0D5D0000000DSv4KAG"
pageSize
sort
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
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.
Sorts the feed items by most recent
post date (CreatedDateDesc) or by
most recent activity
(LastModifiedDateDesc). Activity
includes posts and comments. The
default is CreatedDateDesc.
Response body for GET or HEAD
Feed Item Page
Response body for POST
Feed Item
User-Profile Feed Items Flat
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
or
/chatter/feeds/user-profile/me/feed-items/flat
/chatter/feeds/user-profile/userId/feed-items/flat
Available since version
25.0
169

Chatter API Resources
Users Resources
HTTP methods
GET or HEAD
Request parameters
Parameter Name
numFeedItems
page
recentCommentCount
sort
Type
Integer
String
Integer
String. One of the following:
• CreatedDateDesc
• LastModifiedDateDesc
Description
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.
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.
Specifies the number of recent
comments returned. Valid values are
between 0 and 25. Default value is 3.
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
Users Resources
Information about the user, such as who is following the user, the user’s files or recommendations. Also used for posting feed
items and updating conversation status.
Available resources are:
Resource
/chatter/users
/chatter/users/me
Description
Returns information about all users in an
organization.
Returns information about the logged-in or
specified user's profile.
170

Chatter API Resources
Users Resources
Resource
/chatter/users/batch/user_list
/chatter/users/me/conversations
/chatter/users/me/conversations/conversationId
/chatter/users/me/conversations/conversationId/mark-read
/chatter/users/me/conversations/unread-count
/chatter/users/me/files/
/chatter/users/me/files/filter/groups
/chatter/users/me/files/filter/sharedwithme
/chatter/users/me/followers
/chatter/users/me/following
/chatter/users/me/groups
/chatter/users/me/messages
/chatter/users/me/messages/messageId
/chatter/users/me/photo
/chatter/users/me/recommendations
/chatter/users/me/recommendations/action
/chatter/users/me/recommendations/action/objectCategory
/chatter/users/me/recommendations/action/idPrefix
Description
Returns information about the specified users’
profiles.
Returns all private conversations for the
logged–in user. Also used to search across all
conversations.
Returns information about the specified private
conversation for the logged-in user. Also used
to search within a specific conversation.
Changes the status of the specified conversation.
Returns the number of conversations that have
unread messages for the logged-in or specified
user.
Post a file or get information about files a user
owns. These files don’t include files shared with
a user, files a user follows, or general
organization files.
Returns information about files posted to
groups that the specified user is a member of.
Returns information about files that have been
shared with the specified user.
Returns information about the followers for the
specified user.
Returns a list of people, groups, records, and
files that the specified user is following. Also
used to follow records.
Returns the groups the specified user is a
member of.
Returns all the messages for all the private
conversations for the logged-in user. Also used
to search across all messages and post a message.
Returns the specified message.
Get the URL of a user photo and post a user
photo.
Returns the user, group, file, and record
recommendations for the logged-in user.
Returns the recommendations of the specified
action for the logged-in user.
Returns the recommendations of the specified
action and object category for the logged-in
user. Also used to delete recommendations.
Returns the recommendations of the specified
action and key prefix for the logged-in user.
171

Chatter API Resources
User Information
Resource
/chatter/users/me/recommendations/action/objectID
/chatter/users/me/settings
/chatter/users/me/status
Description
Returns the recommendation of the specified
action and object ID for the logged-in user.
Also used to delete a recommendation.
Information about the context user’s global
Chatter settings.
Returns the most recent user status feed item.
Also used to update or delete user status.
User Information
Returns information about all users in an organization.
Resource
/chatter/users
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
pageSize
q
Type
Integer
Integer
String
Description
An integer specifying a page of items.
The default value is 0, which returns
the first page.
Specifies the number of items per page.
Valid values are between 1 and 250.
The default value is 25.
Specifies the string to search. The
search string must contain at least two
characters, not including any wildcards.
For more information about wildcards,
see Using Wildcards.
Note: The query parameter q only searches user names, not email addresses, titles, and so on.
Response body
User Page
172

Chatter API Resources
User Profile Information
User Profile Information
Returns information about the logged-in or specified user's profile.
Resource
or
/chatter/users/me
/chatter/users/userId
Available since version
23.0
HTTP methods
GET or HEAD
Response body
User Detail
Example response body
{
"aboutMe": "I'm excited to be part of the team focused on building out our apps
business
and showing our customers their future.",
"address": {
"city": "Seattle",
"country": "US",
"formattedAdress": "2001 8th Ave\nSeattle, WA 98121\nUS"
"state": "WA",
"street": "2001 8th Ave",
"zip": "98121"
},
"chatterActivity": {
"commentCount": 0,
"commentReceivedCount": 1,
"likeReceivedCount": 0,
"postCount": 4
},
"chatterInfluence": {
"percentile": "0.5",
"rank": 1
},
"companyName": "Seattle Apps",
"email": "mraven@seattleapps.com",
"firstName": "Marion",
"followersCount": 1,
"followingCounts": {
"people": 5,
"records": 2,
"total": 7
},
"groupCount": 3,
"id": "005D0000001Kl6xIAC",
"isActive": true,
"lastName": "Raven", "managerId": "000000000000000AAA",
173

Chatter API Resources
Batch User Information
"managerName": "",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Marion Raven",
"phoneNumbers": [{
"phoneNumber": "(206) 999-2846",
"type": "Work"
}],
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/F",
"photoVersionId": "729D00000000BDV",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000BDV/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo"
},
"title": null,
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001Kl6xIAC",
"userType": "Internal",
"username": "mraven@seattleapps.com"
Batch User Information
Returns information about the specified users’ profiles.
Resource
/chatter/users/batch/user_list
Where user_list is a comma separated list of user IDs.
Available since version
23.0
HTTP methods
GET or HEAD
Response body
Batch Results
User Conversations, General
Returns all private conversations for the logged–in user. Also used to search across all conversations. See also User Conversations,
Specific on page 176. Also see User Messages, General on page 186.
174

Chatter API Resources
User Conversations, General
Resource
/chatter/users/me/conversations
or
/chatter/users/userId/conversations
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters for GET or HEAD
Parameter Name
page
pageSize
Type
Integer
Integer
Description
Specifies the number of the page you
want returned.
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.
Request parameter for GET
Parameter Name
Type
Description
Since Version
q
String
Specifies the string to search. The search
string must contain at least two characters,
not including any wildcards. For more
information about wildcards, see Using
Wildcards. This parameter is optional.
24.0
Note: The query parameter only
searches message text bodies, not
user names, titles, and so on.
Response body
Conversation Summary Collection
175

Chatter API Resources
User Conversations, Specific
User Conversations, Specific
Returns information about the specified private conversation for the logged-in user. Also used to search within a specific
conversation.
Note: You can also use the Conversations resource to change the status of a specified conversation. See Change
Status of Conversations on page 177.
Resource
/chatter/users/me/conversations/conversationId
or
/chatter/users/userId/conversations/conversationId
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET, PATCH, or HEAD
Request parameter for GET
Parameter Name
Type
Description
Since Version
q
String
Specifies the string to search. The search
string must contain at least two characters,
not including any wildcards. For more
information about wildcards, see Using
Wildcards. This parameter is optional.
24.0
Note: The query parameter only
searches message text bodies, not
user names, titles, and so on.
Request body for PATCH
Root XML tag
176

Chatter API Resources
Change Status of Conversations
Properties
Name
Type
Description
Available Version
read
Boolean
Changes the conversation
status to unread (false)
or read (true).
24.0
Request parameters for PATCH
Parameter Name
read
Type
Boolean
Description
Changes the conversation status to
unread (false) or read (true).
Response body for GET or HEAD
Conversation Detail
Change Status of Conversations
Changes the status of the specified conversation. Also see Using POST, PATCH, or PUT for Input. You can also use PATCH
on the conversations resource to change the status of a specified conversation.
Resource
/chatter/users/me/conversations/conversationId/mark-read
Available since version
23.0
HTTP methods
POST or PUT
Request body
Root XML tag
Properties
Name
Type
Description
Available Version
read
Boolean
Changes the conversation
status to unread (false)
or read (true).
24.0
177

Chatter API Resources
Get Unread Count for Conversations
Request parameters
Parameter Name
read
Type
Boolean
Description
Changes the conversation status to
unread (false) or read (true).
Get Unread Count for Conversations
Returns the number of conversations that have unread messages for the logged-in or specified user.
Resource
/chatter/users/me/conversations/unread-count
OR
/chatter/users/userId/conversations/unread-count
Available since version
23.0
HTTP methods
GET or HEAD
Request body
Conversation Unread Count
Users Files, General
Post a file or get information about files a user owns. These files don’t include files shared with a user, files a user follows, or
general organization files. When you post a file, it is uploaded to the Files tab as a private file and is available only to the file
owner.
To upload a file, you must send it in a multipart/form-data request. You can include the description and title of the file in the
multipart/form-data request as a JSON or XML request body. You can also send the information as request parameters. For
information about how to create the multipart/form-data message, see Uploading Binary Files.
Important: Be aware that this resource may return a large amount of data and may take a while to process.
Resource
or
/chatter/users/me/files/
/chatter/users/userId/files/
178

Chatter API Resources
Users Files, General
Available since version
24.0
HTTP methods
GET, POST, or HEAD
Request body for POST
Describes a new file input. To upload a file, provide the binary file in a multipart/form-data body part where
name="fileData". See Uploading Binary Files.
Root XML tag
JSON
{
}
"desc":"Employee Survey Results",
"title":"emp_surv_results"
Properties
Name
Type
Description
Available Version
desc
String
Description of the file to be
uploaded
24.0
title
String
Title of the file
24.0
Request parameters for POST
Name
Type
Description
Since version
desc
String
Description of the file
24.0
title
String
Title of the file
24.0
Request parameters for GET or HEAD
Parameter Name
Type
Description
Available Since
page
Integer
An integer specifying a page
of items. The default value
is 0, which returns the first
page.
24.0
pageSize
Integer
Specifies the number of
items per page. Valid values
are between 1 and 100. If
24.0
179

Chatter API Resources
Users Files, General
Parameter Name
Type
Description
Available Since
you don't specify a size, the
default is 25.
q
String
A query string to filter the
results. The string must
contain at least two
characters, not including
wildcards. For information
about wildcards, see Using
Wildcards.
27.0
Response body for GET or HEAD
File Page
Response body for POST
File
Example POST request
The following are the body parts in a multipart/form-data request. For more information, see Uploading Binary Files.
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Type: application/json; charset=UTF-8
Content-Disposition: form-data; name="json"
{
}
"desc":"A new file",
"title":"a_new_file"
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq
Content-Disposition: form-data; name="fileData"; filename="foo"
Content-Type: application/octet-stream; charset=ISO-8859-1
This is the content of the file.
--a7V4kRcFA8E79pivMuV2tukQ85cmNKeoEgJgq--
Example POST response
The following is the response from the previous request:
{
"checksum": "2ad78bcc580405c71b68e06b40427873",
"contentSize": 33,
"contentUrl": null,
"description": "A new file",
"downloadUrl":
"/services/data/v27.0/chatter/files/069xx00000000kEAAQ/content?versionNumber=1",
"fileExtension": null,
"fileType": "Unknown",
"flashRenditionStatus": "Na",
"id": "069xx00000000kEAAQ",
"isInMyFileSync": false,
"mimeType": "binary/file",
"modifiedDate": "2013-01-23T23:45:19.000Z",
180

Chatter API Resources
User Files, Filtered by Group
"motif": {
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png"
},
"mySubscription": null,
"name": "a_new_file",
"origin": "Chatter",
"owner": {
"companyName": "signup.org.test.1354045194308",
"firstName": "Darth",
"id": "005xx000001Sv1mAAC",
"isActive": true,
"lastName": "Vader",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Darth Vader",
"photo": {
"fullEmailPhotoUrl":
"http://jhouston-wsl.internal.salesforce.com:8080/ncsphoto/I-72lm_uoAFjw7bpEI9CttSWuwXyrmPgy3Fe3TvaCLzsVFYtThNjjkWPeSX-jVyH",
"largePhotoUrl":
"http://jhouston-wsl.internal.salesforce.com:8080/profilephoto/729xx0000000048/F",
"photoVersionId": "729xx0000000048AAA",
"smallPhotoUrl":
"http://jhouston-wsl.internal.salesforce.com:8080/profilephoto/729xx0000000048/T",
"standardEmailPhotoUrl":
"http://jhouston-wsl.internal.salesforce.com:8080/ncsphoto/I-72lm_uoAFjw7bpEI9CttSWuwXyrmPgy3Fe3TvaCLyCckl76S4UWa24STQON4ov",
}
"url": "/services/data/v27.0/chatter/users/005xx000001Sv1mAAC/photo"
},
"title": "Chairman/President/CEO",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005xx000001Sv1mAAC",
"userType": "Internal"
},
"pageCount": 0,
"pdfRenditionStatus": "Na",
"renditionUrl": null,
"thumb120By90RenditionStatus": "Na",
"thumb240By180RenditionStatus": "Na",
"thumb720By480RenditionStatus": "Na",
"title": "a_new_file",
"type": "ContentDocument",
"url": "/services/data/v27.0/chatter/files/069xx00000000kEAAQ?versionNumber=1",
"versionNumber": "1"
User Files, Filtered by Group
Returns information about files posted to groups that the specified user is a member of.
Resource
/chatter/users/me/files/filter/groups
181

Chatter API Resources
User Files, Filtered by Sharing
or
/chatter/users/userId/files/filter/groups
Available since version
24.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
Type
Description
Available Since
page
Integer
An integer specifying a page
of items. The default value
is 0, which returns the first
page.
24.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.
24.0
q
String
A query string to filter the
results. The string must
contain at least two
characters, not including
wildcards. For information
about wildcards, see Using
Wildcards.
27.0
Response body
File Page
User Files, Filtered by Sharing
Returns information about files that have been shared with the specified user.
Resource
/chatter/users/me/files/filter/shared-with-me
OR
/chatter/users/userId/files/filter/shared-with-me
182

Chatter API Resources
User Followers
Note: The resource can also be accessed with the final keyword as one word:
/chatter/users/me | userid/files/filter/sharedwithme
Available since version
24.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
Type
Description
Available Since
page
Integer
An integer specifying a page
of items. The default value
is 0, which returns the first
page.
24.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.
24.0
q
String
A query string to filter the
results. The string must
contain at least two
characters, not including
wildcards. For information
about wildcards, see Using
Wildcards.
27.0
Response body
File Page
User Followers
Returns information about the followers for the specified user.
Resource
or
/chatter/users/me/followers
/chatter/users/userId/followers
183

Chatter API Resources
Following Users
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
pageSize
Type
Integer
Integer
Description
An integer specifying a page of items.
The default value is 0, which returns
the first page.
Specifies the number of items per page.
Valid values are between 1 and 1000.
If you don't specify a size, the default
is 25.
Response body
Follower Page
Following Users
Returns a list of people, groups, records, and files that the specified user is following. Also used to follow records. See Using
POST, PATCH, or PUT for Input.
Note: You can't use the users resource to add a user to a group. Use the groups resource instead.
Resource
or
/chatter/users/me/following
/chatter/users/userId/following
Available since version
23.0
HTTP methods
GET, POST, or HEAD
Request body for POST
Root XML tag
184

Chatter API Resources
Following Users
Properties
Name
Type
Description
Available Version
subjectId
String
The ID of what to follow,
for example, a user ID, a
record ID, a file ID, and so
on.
23.0
Note: Use Group
Member Input for
adding members
to groups.
Request parameter for POST
Parameter Name
subjectId
Type
String
Description
This request enables the user to follow
the specified record. This could be a
user ID, a file ID, and so on.
Request parameters for GET or HEAD
All parameters are optional.
Parameter Name
filterType
page
pageSize
Type
String
Integer
Integer
Description
Specifies the key prefix to filter the type
of objects returned. 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.
An integer specifying a page of items.
The default value is 0, which returns
the first page.
Specifies the number of items per page.
Valid values are between 1 and 1000.
If you don't specify a size, the default
is 25.
185

Chatter API Resources
User Groups
Response body for GET or HEAD
Following Page
Response body for POST
Subscription
User Groups
Returns the groups the specified user is a member of.
Resource
/chatter/users/me/groups
OR
/chatter/users/userId/groups
Available since version
23.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
page
pageSize
Type
Token
Integer
Description
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.
Specifies the number of items per page.
Valid values are between 1 and 250. If
you don’t specify a size, the default is
25.
Response body
User Group Page
User Messages, General
Returns all the messages for all the private conversations for the logged-in user. Also used to search across all messages and
post a message. See Using POST, PATCH, or PUT for Input. See also User Conversations, General on page 174.
Resource
/chatter/users/me/messages
186

Chatter API Resources
User Messages, General
or
/chatter/users/userId/messages
Note: userId must be the same as the logged-in user.
Available since version
23.0
HTTP methods
GET, POST, or HEAD
Request body for POST
Root XML tag
Properties
Name
Type
Description
Available Version
body
String
Text of the message body
23.0
inReplyTo
String
ID of an existing message
that identifies which
conversation this message
is part of
23.0
recipients
User Message Recipient
List Input
List of users who are the
intended message
recipients, up to 9.
Comma-separated list of
user IDs.
23.0
Note: Either recipients or inReplyTo is required You must specify one or the other, not both.
Example XML format:
Text of the message
userID
userID
messageID
187

Chatter API Resources
User Messages, General
Example JSON format:
{
}
"body": "Text of the message",
"recipients": ["userID","userID"],
"inReplyTo": "messageID"
Request parameters for POST
Parameter Name
Type
Required or Optional
Description
inReplyTo
ID messageID
Either recipients or
inReplyTo is required
ID of an existing message
that identifies which
conversation this message is
part of
recipients
ID userID
Either recipients or
inReplyTo is required
List of users who are the
intended message recipients,
up to 9. Comma-separated
list of user IDs.
text
String
Required
The text of the message, up
to 10,000 characters
Request parameters for GET or HEAD
Parameter Name
page
pageSize
Type
Integer
Integer
Description
Specifies the number of the page you
want returned.
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.
Request parameter for GET
Parameter Name
Type
Description
Since Version
q
String
Specifies the string to search. The search
string must contain at least two characters,
not including any wildcards. For more
information about wildcards, see Using
Wildcards. This parameter is optional.
24.0
Note: The query parameter only
searches message text bodies, not
user names, titles, and so on.
188

Chatter API Resources
User Messages, General
Response body for GET or HEAD
Message Collection
Response body for POST
Message
Example response body for GET or HEAD
{
"currentPageUrl": "/services/data/v27.0/chatter/users/me/messages",
"messages": [
{
"body": {
"messageSegments": [],
"text": "Will you be able to meet about your Dreamforce presentation this
week?"
},
"conversationId": "03MD000000002LTMAY",
"conversationUrl":
"/services/data/v27.0/chatter/users/me/conversations/03MD000000002LTMAY",
"id": "03JD000000003XGMAY",
"recipients": [
{
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
},
{
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
"companyName": null,
"firstName": "Desmond",
"id": "005D0000001LJvOIAW",
"isActive": true,
"lastName": "Catillo",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
189

Chatter API Resources
User Messages, General
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Desmond Catillo",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO1IAO/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LJvOIAW",
"userType": "Internal"
}
],
"sender": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
},
{
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"sentDate": "2012-07-20T21:27:07.000Z",
"url": "/services/data/v27.0/chatter/users/me/messages/03JD000000003XGMAY"
"body": {
"messageSegments": [],
"text": "Rene Holmes has shared Recruitment Poster.png with you on
Chatter.\n\nPlease review.\n\nTo view the file, go to:
https://na1-blitz01.soma.salesforce.com/069D00000001E32"
190

Chatter API Resources
User Messages, General
},
"conversationId": "03MD000000002LTMAY",
"conversationUrl":
"/services/data/v27.0/chatter/users/me/conversations/03MD000000002LTMAY",
"id": "03JD000000003VAMAY",
"recipients": [
{
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
},
{
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
"companyName": null,
"firstName": "Desmond",
"id": "005D0000001LJvOIAW",
"isActive": true,
"lastName": "Catillo",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Desmond Catillo",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO1IAO/photo"
191

Chatter API Resources
User Messages, Specific
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LJvOIAW",
"userType": "Internal"
}
],
"sender": {
"companyName": "SeattleApps",
"firstName": "Rene",
"id": "005D0000001LFNnIAO",
"isActive": true,
"lastName": "Holmes",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": null,
"name": "Rene Holmes",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sZVyX4qlsJTXfOWM77RW7yt",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/F",
"photoVersionId": "729D00000000XA5",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000XA5/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cEw-MQI3xmkJ21oNEOQ-5sbktFTIf9vWhFTTALJiaFz_",
}
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": "Senior Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LFNnIAO",
"userType": "Internal"
},
"sentDate": "2012-07-18T19:01:51.000Z",
"url": "/services/data/v27.0/chatter/users/me/messages/03JD000000003VAMAY"
},
"nextPageUrl": null
User Messages, Specific
Returns the specified message.
Resource
/chatter/users/me/messages/messageId
or
/chatter/users/userId/messages/messageId
Note: userId must be the same as the logged-in user.
192

Chatter API Resources
User Photo
Available since version
23.0
HTTP methods
GET or HEAD
Response body
Message
User Photo
Get the URL of a user photo and post a user photo.
To use a file from the Files list, use the request body or request parameters in this entry.
To upload a binary file, you must send it in a multipart/form-data message. For information about how to create the
multipart/form-data message, see Uploading Binary Files.
To display user profile photos in a feed, cache the user photos. Then use the photoVersionId to determine when you need
to update a photo. This technique helps you avoid running over limits and may improve mobile client performance.
Resource
/chatter/users/me/photo
OR
/chatter/users/userId/photo
Available since version
23.0
HTTP methods
GET, POST or HEAD
Request body for POST
Describes an existing photo input. To upload a new photo, provide the binary file in a multipart/form-data body
part where name="fileUpload". See Uploading Binary Files.
Root XML tag
Properties
Name
Type
Description
Available Version
fileId
String
18 character Id of an
existing file. The key prefix
must be 069 and the file
size must be less than 2
MB.
25.0
193

Chatter API Resources
User Recommendations, General
Name
versionNumber
Type
Integer
Description
Version number of an
existing file. If not
provided, the latest version
is used.
Available Version
25.0
Request parameters for POST
Parameter Name
Type
Description
Available Version
fileId
String
18 character ID of an
existing file. The key prefix
must be 069 and the file size
must be less than 2 MB.
25.0
versionNumber
Integer
Version number of the
existing content. If not
provided, the latest version
is used.
25.0
Note: Photos are processed asynchronously and may not be visible right away.
Response body for GET or HEAD
Photo
Response body for POST
Photo
User Recommendations, General
Returns the user, group, file, and record recommendations for the logged-in user.
Resource
/chatter/users/me/recommendations
OR
/chatter/users/userId/recommendations
Note: userId must be the same as the logged-in user.
194

Chatter API Resources
User Recommendations, General
Available since version
24.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
maxResults
Type
Integer
Description
Maximum number of recommendation
results; default is 10. Value must be
greater than 0.
Response body
Zero or more Recommendation responses
Example response body for GET with no request parameters
{"recommendations": [
{
"actOnUrl":
"/services/data/v27.0/chatter/users/005D0000001LL8OIAW/following?subjectId=00QD000000GWGuXMAX",
},
{
"action": "follow",
"explanation": {
"detailsUrl": null,
"summary": "Owned by you",
"type": "RecordOwned"
},
"object": {
"id": "00QD000000GWGuXMAX",
"motif": {
"largeIconUrl": "/img/icon/leads64.png",
"mediumIconUrl": "/img/icon/leads32.png",
"smallIconUrl": "/img/icon/leads16.png"
},
"mySubscription": null,
"name": "Pamela Owenby, Hendrickson Trading",
"type": "Lead",
"url": "/services/data/v27.0/chatter/records/00QD000000GWGuXMAX"
}
"actOnUrl":
"/services/data/v27.0/chatter/groups/0F9D00000000I4TKAU/members?userId=005D0000001LL8OIAW",
"action": "join",
"explanation": {
"detailsUrl":
"/services/data/v27.0/chatter/users/me/recommendations/join/0F9D00000000I4TKAU/explanation/GroupMembersFollowed",
"summary": "Has members you follow",
"type": "GroupMembersFollowed"
},
"object": {
"canHaveChatterGuests": false,
"community": null,
"description": "Get help from colleagues to close deals faster",
195

Chatter API Resources
User Recommendations, General
"fileCount": 0,
"id": "0F9D00000000I4TKAU",
"lastFeedItemPostDate": "2012-09-12T01:03:08.000Z",
"memberCount": 2,
"motif": {
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},
"myRole": "NotAMember",
"mySubscription": null,
"name": "Sales",
"owner": {
"companyName": "Universal Containers",
"firstName": "Renee",
"id": "005D0000001LLO6IAO",
"isActive": true,
"lastName": "Moreau",
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
"mySubscription": {
"id": "0E8D0000000T5ZZKA0",
"url": "/services/data/v27.0/chatter/subscriptions/0E8D0000000T5ZZKA0"
},
"name": "Renee Moreau",
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1i9x6Z16L8wXEGigpcWjAd",
"largePhotoUrl":
"https://c.na1-blitz02.content.soma.force.com/profilephoto/729D00000000LJQ/F",
"photoVersionId": "729D00000000LJQIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJQ/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cGW2pGjfqoWUUgTENHjVyS1q43x_rW2ciXBHst0Eh3Y6",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO/photo"
},
"title": "Sales Manager",
"type": "User",
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO",
"userType": "Internal"
},
"photo": {
"fullEmailPhotoUrl":
"https://instance_name/ncsphoto/0_6z_M1zlQXy0iICaZWfdyWvj8Hy5cv5voDy7d7Kam0yU5fZl49rmMAeVigTKI9v",
"largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJU/F",
"photoVersionId": "729D00000000LJUIA2",
"smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJU/T",
"standardEmailPhotoUrl":
"https://instance_name/ncsphoto/0_6z_M1zlQXy0iICaZWfdyWvj8Hy5cv5voDy7d7Kam12q55tdEhTcGehjW_lHrWP",
]}
}
}
"url": "/services/data/v27.0/chatter/users/005D0000001LLO6IAO/photo"
},
"type": "CollaborationGroup",
"url": "/services/data/v27.0/chatter/groups/0F9D00000000I4TKAU",
"visibility": "PublicAccess"
196

Chatter API Resources
User Recommendations for a Specific Action
User Recommendations for a Specific Action
Returns the recommendations of the specified action for the logged-in user.
Resource
or
/chatter/users/me/recommendations/action
/chatter/users/userId/recommendations/action
Note: userId must be the same as the logged-in user.
Valid values for action and resulting recommendations:
• follow returns recommendations to follow users, files, and records.
• join returns recommendations to join groups.
• view returns recommendations to view users, files, groups, and records. Available in versions 25.0 and later.
Available since version
24.0
HTTP methods
GET or HEAD
Request parameters
Parameter Name
maxResults
Type
Integer
Description
Maximum number of recommendation
results; default is 10. Value must be
greater than 0.
Response body
Zero or more Recommendation responses
User Recommendations for a Specific Action and Object Category
Returns the recommendations of the specified action and object category for the logged-in user. Also used to delete
recommendations.
Resource
/chatter/users/me/recommendations/action/objectCategory
197

Chatter API Resources
User Recommendations for a Specific Action and Object
Category
or
/chatter/users/userId/recommendations/action/objectCategory
Note: userId must be the same as the logged-in user.
• Valid values for action:
◊
◊
◊
follow
join
view (Available in versions 25.0 and later.)
• Valid values for object category:
◊
◊
◊
If action is follow, object category is users, files, or records.
If action is join, object category is groups.
If action is view, object category is users, files, groups, or records.
Available since version
23.0
HTTP methods
GET, DELETE, or HEAD
DELETE is available as of version 24.0. DELETE is used to remove a recommendation and is only valid for the
following resources:
• /chatter/users/me | userId/recommendations/follow/recommendedUserId
• /chatter/users/me | userId/recommendations/follow/recommendedFileId
• /chatter/users/me | userId/recommendations/follow/recommendedRecordId
• /chatter/users/me | userId/recommendations/join/recommendedGroupId
Note: userId must be the same as the logged-in user.
Request parameters for GET or HEAD
Parameter Name
Type
Description
Since Version
maxResults
Integer
Maximum number of recommendation
results; default is 10. Value must be
greater than 0.
23.0
followed
String
ID of a user. Provides new
recommendations based on the context
of this user ID.
24.0
viewed
String
ID of a file. Provides new
recommendations based on the context
of this file ID.
25.0
198

Chatter API Resources
User Recommendations for a Specific Action and Key Prefix
Example request URL with followed request parameter
/chatter/users/me/recommendations/follow/users?followed=005D0000001GLowIAB
Response body for GET with followed request parameter
Zero or one user Recommendation response
Response body for GET or HEAD without request parameters
Zero or more Recommendation responses
Response body for DELETE
204: Successful Delete
User Recommendations for a Specific Action and Key Prefix
Returns the recommendations of the specified action and key prefix for the logged-in user. 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.
Resource
/chatter/users/me/recommendations/action/idPrefix
or
/chatter/users/userId/recommendations/action/idPrefix
Note: userId must be the same as the logged-in user.
• Valid values for action:
◊
◊
◊
follow
join
view
• Valid values for idPrefix:
◊ If action is follow, idPrefix is the key prefix for users (005), files (069), or records (such as 001 or 003).
◊ If action is join, idPrefix is the key prefix for groups (0F9).
◊ If action is view, idPrefix is the key prefix for users (005), files (069), groups (0F9), or records (such as 001
or 003).
Available since version
26.0
HTTP methods
GET or HEAD
199

Chatter API Resources
User Recommendations for a Specific Action and Object ID
Request parameters for GET or HEAD
Parameter Name
maxResults
followed
viewed
Type
Integer
String
String
Description
Maximum number of recommendation
results; default is 10. Value must be
greater than 0.
ID of a user. Provides new
recommendations based on the context
of this user ID.
ID of a file. Provides new
recommendations based on the context
of this file ID.
Example request URL
/chatter/users/me/recommendations/view/001
Response body for GET or HEAD without request parameters
Zero or more account Recommendation responses
User Recommendations for a Specific Action and Object ID
Returns the recommendation of the specified action and object ID for the logged-in user. Also used to delete a recommendation.
Resource
/chatter/users/me/recommendations/action/objectID
or
/chatter/users/userId/recommendations/action/objectID
Note: userId must be the same as the logged-in user.
• Valid values for action:
◊
◊
◊
follow
join
view (Available in versions 25.0 and later.)
• Valid values for object ID:
◊
◊
◊
If action is follow, object ID is a user ID, file ID, or record ID.
If action is join, object ID is a group ID.
If action is view, object ID is a user ID, file ID, group ID, or record ID.
200

Chatter API Resources
User Settings
Available since version
24.0
HTTP methods
GET, DELETE, or HEAD
DELETE is used to remove a recommendation and is only valid for the following resources:
• /chatter/users/me | userId/recommendations/follow/recommendedUserId
• /chatter/users/me | userId/recommendations/follow/recommendedFileId
• /chatter/users/me | userId/recommendations/follow/recommendedRecordId
• /chatter/users/me | userId/recommendations/join/recommendedGroupId
Note: userId must be the same as the logged-in user.
Request parameters for GET or HEAD
Parameter Name
maxResults
followed
Type
Integer
String
Description
Maximum number of recommendation
results; default is 10. Value must be
greater than 0.
ID of a user. Provides new
recommendations based on the context
of this user ID.
Response body for GET or HEAD without request parameters
Zero or one Recommendation response
Response body for DELETE
204: Successful Delete
User Settings
Information about the context user’s global Chatter settings.
Resource
or
/chatter/users/me/settings
/chatter/users/userId/settings
Note: The userId must be the same as the logged-in user.
201

Chatter API Resources
User Settings
Available since version
27.0
HTTP methods
GET, HEAD, or PATCH
Request body for PATCH
Root XML tag
Properties
Name
defaultGroupEmailFrequency
Type
String
Description
The default frequency with which a user
receives email from a group when they
join. Valid values are:
• EachPost
• DailyDigest
• WeeklyDigest
• Never
Available
Version
27.0
Request parameter for PATCH
Parameter Name
defaultGroupEmailFrequency
Type
String
Description
The default frequency with 27.0
which a user receives email
from a group when they join.
This setting does not affect
groups a user is already a
member of. Valid values are:
• EachPost
• DailyDigest
• WeeklyDigest
• Never
Available Since
Response body for GET, HEAD, or PATCH
User Chatter Settings
Response body example for GET
{"defaultGroupEmailFrequency": "Never"}
202

Chatter API Resources
User Status
User Status
Note: This resource is no longer available as of version 25.0. Instead, use any feed resource, with the feed-item, such
as /chatter/feeds/news/me/feed-items.
Returns the most recent user status feed item. Also used to update or delete user status. See Using POST, PATCH, or PUT
for Input.
Resource
or
/chatter/users/me/status
/chatter/users/userId/status
Available in versions
23.0–24.0
HTTP methods
GET, DELETE, POST or HEAD
Request body for POST
Root XML tag
Properties
Name
Type
Description
Available Version
body
Message Body Input
Description of message
body
23.0–24.0
Request parameter for POST
Name
text
Type
String Text to post
Description
Text of the item to be posted to the
user's status
Response body for GET or POST
User Status
203

Chatter API Resources
User Status
Example response body
Will send you latest updates tonight
Text
Will send you latest updates tonight
005D0000001GLbn
/services/data/v27.0/chatter/users/005D0000001GLbn/status
204

Chapter 5
Chatter API Request Bodies
To perform a POST, PATCH, or PUT request, pass query parameters or create a request body formatted in either XML or
JSON.
The following are the top-level request bodies, and can contain one or more other request bodies nested inside:
• Attachment Input: Feed Poll
• Comment
• Dashboard Component Snapshot
• Feed Favorite
• Feed Item
• Feed Poll
• File Input
• Following
• Group Chatter Settings
• Group Member
• Group Membership Request Update
• Photo
• User Chatter Settings
• User Message
• User Message Recipient
• User Message Recipient List
• User Status
• User Stream (Conversation)
All request bodies have properties. If a request body is top-level, it has a root XML tag listed. To create an XML request body,
nest the properties as XML tags inside the root XML tag.
The following is an example of a comment XML request body:
Let's look for a new solution.
To create a JSON request body, use the properties in JSON format. You don’t need to use the root XML tag.
The following is the same comment example used above, in JSON format:
{
"body" : "Let's look for a new solution."
}
205

Chatter API Request Bodies
Attachment Input: Existing Content
XML
In XML request bodies, attachmentType is an attribute of the element.
069...
JSON
{ "attachment":
{
"attachmentType":"ExistingContent",
"contentDocumentId": "069D00000001FHF"
}
}
Properties
Name
Type
Description
Available Version
attachmentType
String
The attachment type. Must
contain the value
ExistingContent.
27.0
contentDocumentId
String
ID of the existing content
23.0
Attachment Input: Feed Poll
XML
Note that in XML, the choices for the poll are each wrapped in a element and attachmentType is an attribute
of the element. For example:
One
Two
JSON
{ "attachment":
{
"attachmentType":"Poll",
"pollChoices": [
"Monday",
"Tuesday"
]
}
}
206

Chatter API Request Bodies
Properties
Name
Type
Description
Available Version
attachmentType
String
The attachment type. Must
contain the value Poll.
27.0
pollChoices
String []
A list of choices used in the
feed poll.
26.0
Attachment Input: Link
XML
The attachmentType property is an attribute of the element. For example:
http://www.google.com
A search engine
JSON
{ "attachment":
{
"attachmentType":"Link",
"url": "http://www.salesforce.com",
"urlName": "Salesforce"
}
}
Properties
Name
Type
Description
Available Version
attachmentType
String
The attachment type. Must
contain the value Link.
27.0
url
String
URL included in the
attachment
23.0
urlName
String
Optional. Name of the URL.
If not provided, a name is
generated from the domain
name of the URL
23.0
Attachment Input: New File Upload
To upload a new file, provide the binary file in a multipart/form-data body part where name="feedItemFileUpload".
See Uploading Binary Files.
207

Chatter API Request Bodies
XML
The attachmentType property is an attribute of the element. For example:
TPS Report (with cover)
TPS.txt
JSON
{ "attachment":
{
"attachmentType":"NewFile",
"description":"TPS Report (with cover)",
"title":"TPS.txt"
}
}
Properties
Name
Type
Description
Available Version
attachmentType
String
The attachment type. Must contain the
value NewFile.
27.0
desc
String
Description of the file
23.0–26.0
Attention: This parameter
should not be used as of version
27.0. Use description
instead.
description
String
Optional. Description of the file.
27.0
title
String
Title of the file
24.0
Comment Input
Root XML tag
JSON
The following example attaches an existing file to a comment:
{
"attachment": {
"attachmentType":"ExistingContent",
"contentDocumentId":"069D00000001FHF"
},
"body" : {
"messageSegments" : [
{
"text" : "FY14 Sales Projections",
208

Chatter API Request Bodies
}
}
]
}
"type" : "Text"
Properties
Name
Type
Description
Available
Version
attachment
Depends on type.
Optional. Values are:
• Attachment Input: Existing Content
• Attachment Input: New File Upload
24.0
Note: To upload a new file, you
must include it in a
multipart/form–data message.
See Uploading Binary Files.
body
Message Body Input
Description of message body
23.0
Dashboard Component Snapshot Input
Root XML tag
JSON
{
}
"parentId" : "0F9D00000000I4O",
"feedItemBody" : {
"messageSegments" : [
{
"text" : "Sales Heat",
"type" : "Text"
}
]
}
Properties
Name
Type
Description
Available Version
parentId
String
A user, group, or dashboard Id to
which you are posting the
snapshot.
25.0
filterId1
String
Optional. A dashboard filter item
Id.
25.0
209

Chatter API Request Bodies
Name
filterId2
filterId3
feedItemBody
runningUserId
Type
String
String
Message Body
Input
String
Description
Optional. A second dashboard
filter item Id.
Optional. A third dashboard filter
item Id.
Contains the text that accompanies
the feed item associated with the
dashboard component snapshot.
Optional. A user Id from which
the view of the dashboard will be
created, if other than the creator.
Available Version
25.0
25.0
25.0
25.0
Feed Favorite Input
Root XML tag
JSON
{
}
"searchText" : "release"
Properties for POST
Name
Type
Description
Available Version
searchText
String
Text of the feed search. This
parameter can only be used
with saved searches and not
list views.
24.0
Properties for PATCH
Name
Type
Description
Available Version
updateLastViewDate
Boolean
Sets the last view date of the
specified feed favorite to the
current system time. Default
value is false.
24.0
210

Chatter API Request Bodies
Feed Item Input
Root XML tag
JSON
The following example attaches a poll to a feed item:
{ "attachment":
{
"attachmentType":"Poll",
"pollChoices": [
"Monday",
"Tuesday"
]
},
"body" : {
"messageSegments" : [
{
"type" : "Text",
"text" : "When should we meet for release planning?"
}
]
}
}
Properties
Name
attachment
Type
Depends on type
Description
Optional. You can specify only one of these
values in the attachment parameter. Values
are:
• Attachment Input: Existing Content
(v23.0)
• Attachment Input: Feed Poll (v26.0)
• Attachment Input: Link (v23.0)
• Attachment Input: New File Upload
(v23.0)
Note: To upload a new file,
you must include it in a
multipart/form–data message.
See Uploading Binary Files.
Available
Version
body
isBookmarkedByCurrentUser
Message Body Input
Boolean
Description of message body
Optional. Specifies if the new feed item
should be bookmarked for the user (true)
or not (false). Default value is false.
23.0
24.0
211

Chatter API Request Bodies
Name
originalFeedItemId
Type
String
Description
Optional. If this feed item is shared, this is
the original feed item 18-character Id
Note: 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.
Available
Version
24.0
visibility
String
Optional. Who can see the post. Valid
values are:
• InternalUsers
• AllUsers
26.0
Note: Portal users in communities
still won’t see posts with
AllUsers specified.
Also see Record Feed Items for more
information about visibility
Feed Poll Input
Root XML tag
Properties
Name
myChoiceId
Type
String
Description
Id of an existing choice on 26.0
the feed poll. Used to specify
the Id of the poll choice that
the current user is voting on.
Available Version
File Input
Describes a new file input. To upload a file, provide the binary file in a multipart/form-data body part where
name="fileData". See Uploading Binary Files.
Root XML tag
212

Chatter API Request Bodies
JSON
{
}
"desc":"Employee Survey Results",
"title":"emp_surv_results"
Properties
Name
Type
Description
Available Version
desc
String
Description of the file to be
uploaded
24.0
title
String
Title of the file
24.0
Following Input
Root XML tag
Properties
Name
Type
Description
Available Version
subjectId
String
The ID of what to follow, for
example, a user ID, a record
ID, a file ID, and so on.
23.0
Note: Use Group
Member Input for
adding members to
groups.
Group Chatter Settings Input
Root XML tag
Properties
A user’s Chatter settings.
213

Chatter API Request Bodies
Name
Type
Description
Available
Version
emailFrequency
String
The frequency with which a group
member receives email from a group.
Valid values are:
• EachPost
• DailyDigest
• WeeklyDigest
• Never
27.0
Group Member Input
Root XML tag
Properties
Name
Type
Description
Available Version
userId
String
The user ID of the member
to be added to the group
23.0
Group Membership Request Update
Root XML tag
Properties
Name
Type
Description
Available Version
responseMessage
String
Use this property to provide a message to the
user if their membership request is declined.
The value of this property is used only when
the value of the status property is
Declined.
27.0
The maximum length is 756 characters.
status
String
Valid values:
• Accepted
• Declined
27.0
214

Chatter API Request Bodies
Message Body Input
Name
Type
Description
Available Version
messageSegments
Segments[]
Collection of message
segments, based on type.
Segments can be one of the
following:
• Message Segment Input:
Hash Tag
• Message Segment Input:
Link
• Message Segment Input:
Mention
• Message Segment Input:
Text
23.0
Message Segment Input: Hash Tag
Represents an inline hash tag. If a hash tag is provided as input without whitespace text before it, a space is inserted. If a hash
tag is provided as input without whitespace text after it, a space is inserted.
The use of this segment is optional because hash tags are also parsed out of Text segments.
Name
Type
Description
Available Version
tag
String
Text of the hash tag without
the hash tag
23.0
type
String
Value is Hashtag
23.0
Message Segment Input: Link
Represents an inline link to a URL. If a link is provided as input without whitespace text before it, a space is inserted. If a link
is provided as input without whitespace text after it, a space is inserted.
The use of this segment is optional because links are also parsed out of Text segments.
Name
Type
Description
Available Version
type
String
Value is Link
23.0
url
URL
URL to be used for the link
23.0
Message Segment Input: Mention
Represents an inline mention of a user. You must provide a user ID. No spaces are added.
Name
Type
Description
Available Version
id
String
ID of the user to be mentioned
23.0
type
String
Value is Mention
23.0
215

Chatter API Request Bodies
Message Segment Input: Text
Represents plain inline text. Text prefixed with a # and surrounded by space is converted into a hash tag segment. Text that
looks like a link and is surrounded by space is converted into a link segment.
Name
Type
Description
Available Version
text
String
Plain text for this segment
23.0
type
String
Only value is Text
23.0
Photo Input
Describes an existing photo input. To upload a new photo, provide the binary file in a multipart/form-data body part
where name="fileUpload". See Uploading Binary Files.
Root XML tag
Properties
Name
Type
Description
Available Version
fileId
String
18 character Id of an existing
file. The key prefix must be
069 and the file size must be
less than 2 MB.
25.0
versionNumber
Integer
Version number of an
existing file. If not provided,
the latest version is used.
25.0
User Chatter Settings Input
A user’s global Chatter settings.
Root XML tag
Properties
Name
defaultGroupEmailFrequency
Type
String
Description
The default frequency with which a user
receives email from a group when they join.
Valid values are:
• EachPost
• DailyDigest
• WeeklyDigest
• Never
Available
Version
27.0
216

Chatter API Request Bodies
User Message
Root XML tag
Properties
Name
body
inReplyTo
recipients
Type
String
String
User Message Recipient List
Input
Description
Text of the message body
ID of an existing message
that identifies which
conversation this message is
part of
List of users who are the
intended message recipients,
up to 9. Comma-separated
list of user IDs.
Available Version
23.0
23.0
23.0
Note: Either recipients or inReplyTo is required You must specify one or the other, not both.
Example XML format:
Text of the message
userID
userID
messageID
Example JSON format:
{
}
"body": "Text of the message",
"recipients": ["userID","userID"],
"inReplyTo": "messageID"
User Message Recipient Input
Root XML tag
Properties
Name
Type
Description
Available Version
recipient
String
18-character Id of the user
to receive the message
23.0
217

Chatter API Request Bodies
User Message Recipient List Input
Root XML tag
Properties
Name
Type
Description
Available Version
recipients
User Message Recipient
Input[]
Collection of recipients to
receive the message
23.0
User Status Input
Note: Setting a user status is no longer available as of version 25.0. Post feed items to the feed instead, using Feed
Item Input.
Root XML tag
Properties
Name
Type
Description
Available Version
body
Message Body Input
Description of message body
23.0–24.0
User Stream (Conversation) Input
Root XML tag
Properties
Name
Type
Description
Available Version
read
Boolean
Changes the conversation
status to unread (false) or
read (true).
24.0
218

Chapter 6
Chatter API Resource Returns
The Chatter API resources return an HTTP response code. They can also return a response body, in either JSON or XML.
Response Bodies
The following are the response bodies returned by successful execution of a resource request.
Address
Property
Type
Description
Since Version
city
String
Name of the city
23.0
country
String
Name of the country
23.0
formattedAddress
String
Address formatted by locale.
25.0
state
String
Name of the state, province, or so on
23.0
street
String
Street number
23.0
zip
String
Zip or postal code
23.0
Batch Results
Property
Type
Description
Since Version
results
Batch Result Item[]
Collection of batch result items
23.0
Batch Result Item
Property
Type
Description
Since Version
result
Various
Dependent on the type of batch. Value
could be one of the following:
• Error Message (v23.0)
• File for
/chatter/files/batch/
fileIds
219

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
(v26.0)
• Group Member for
/chatter/group-memberships/batch/
membershipIds
(v27.0)
• Group for
/chatter/groups/batch/
groupIds
(v23.0)
• Motif for
/connect/motifs/batch/
idOrPrefixList
v27.0
• User Summary for
/chatter/users/batch/
userIds
(v23.0)
statusCode
Integer
An HTTP status code indicating the status
of this individual request in the batch.
23.0
Chatter Activity
Property
Type
Description
Since Version
commentCount
Integer
Total number of comments in the
organization made by the user
23.0
commentReceivedCount
Integer
Total number of comments in the
organization received by the user
23.0
likeReceivedCount
Integer
Total number of likes on posts and
comments in the organization received by
the user
23.0
postCount
Integer
Total number of posts in the organization
made by the user
23.0
220

Chatter API Resource Returns
Response Bodies
Chatter Directory
Property
Type
Description
Since Version
feeds
String
Returns a URL to the general feeds
resource for the organization
24.0
groups
String
Returns a URL to the general groups
resource for the organization
24.0
organization
String
Note: This property is no longer
available as of version 26.0. Use
the organization property in
the Connect Directory instead.
24.0–26.0
Returns a URL to the general connect
organization resource
users
String
Returns a URL to the general users
resource for the organization
24.0
Chatter Influence
Property
Type
Description
Since Version
percentile
String
Percentile value for the user’s influence rank
within the organization
24.0
rank
Integer
Number indicating the user’s influence rank,
relative to all other users within the
organization
24.0
ClientInfo
Property
Type
Description
Since Version
applicationName
String
Name of the Connected App used for
authentication. For more information, see
Understanding Connected Apps.
23.0
applicationUrl
String
Value from the Info URL field of the
Connected App used for authentication
23.0
Comment
Property
Type
Description
Since Version
attachment
Depends on type of comment
If the comment does not contain an
attachment or if the attachment, returns
null. Otherwise, returns Feed Item
Attachment: Content.
24.0
body
Feed Body
Message body comment
23.0
221

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
clientInfo
ClientInfo
Information about the Connected App used
to authenticate the connection
23.0
createdDate
String
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
23.0
feedItem
Reference
Information about the feed item for the
comment
23.0
id
String
18-character Id of the comment
23.0
isDeletable
Boolean
Note: This property is no longer
available as of version 25.0. Use the
isDeleteRestricted property
instead.
23.0–24.0
Specifies if the context user can delete the
comment
isDeleteRestricted
likes
likesMessage
myLike
parent
type
Boolean
Like Page
Like Message Body
Reference
Parent
String
Returns true if a comment cannot be deleted
by the logged in user. If it returns false,
possibly the logged in users can delete the
comment.
Page of likes associated with the comment
A message body that describes who likes the
comment.
If the logged-in user has liked the comment,
returns a reference to that like or returns null
Information about the parent of the feed-item
associated with this comment
Indicates the type of comment. Valid values
are:
• ContentComment—the comment
contains an attachment
• TextComment—the comment contains
only text
25.0
24.0
27.0
23.0
23.0
24.0
url
String
URL to this comment
23.0
user
User Summary
Information about the comment author
23.0
Comment Page
Property
Type
Description
Since Version
comments
Comment[]
Collection of comments
23.0
222

Chatter API Resource Returns
Response Bodies
Property
currentPageUrl
nextPageUrl
total
Type
String
String
Integer
Description
URL to the first page of comments, that is,
the most recent comments. The default is 25
comments per page.
URL to the next page of comments, that is,
older comments. The default is 25 comments
per page.
Total number of comments across all pages
for the parent feed item
Since Version
23.0
23.0
23.0
Community
Note: Communities are available as a pilot program.
Property
description
id
invitationsEnabled
name
sendWelcomeEmail
status
Type
String
String
Boolean
String
Boolean
String
Description
Community’s description
18-character Id of the community
Specifies if members of the community can
invite other members to the community, true
if they can, false otherwise.
Community name
Specifies if a welcome email is automatically
generated and sent to any new member. true
if email is sent, false otherwise.
Community’s status. Values are:
• Active
• Inactive
• UnderConstruction
Since
Version
26.0
26.0
26.0
26.0
26.0
26.0
urlPathPrefix
String
Community-specific URL prefix
26.0
url
String
Full URL to community
26.0
Community Page
Note: Communities are available as a pilot program.
Property
communities
Type
Community []
Description
List of communities available to the current user
Since
Version
26.0
223

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since
Version
total
Integer
Total number of communities
26.0
Connect Directory
Property
communities
Type
Community []
Description
List of communities in the current organization
Note: Communities are available as a
pilot program.
Since
Version
26.0
organization
String
URL to the Chatter organization
25.0
Conversation Detail
Property
id
members
messages
read
url
Type
String
User Summary[]
Message Collection
Boolean
String
Description
18-character Id of the conversation
Collection of users participating in this
conversation
Messages in this conversation
Does the context user have unread messages in
this conversation?
URL to the conversation detail page
Since
Version
23.0
23.0
23.0
23.0
23.0
Conversation Summary
Property
Type
Description
Since
Version
id
String
18-character Id of the conversation
23.0
latestMessage
Message
The most recent message in this conversation
23.0
members
User Summary[]
Collection of users participating in the
conversation
23.0
read
Boolean
Does the context user have unread messages in
this conversation?
23.0
url
String
URL to the conversation detail page
23.0
224

Chatter API Resource Returns
Response Bodies
Conversation Summary Collection
Property
Type
Description
Since Version
conversations
Conversation Summary[]
Collection of one or more conversations
23.0
currentPageUrl
String
URL to the first page of conversations, that
is, the conversations with the most recent
messages
23.0
nextPageUrl
String
URL to the next page of messages, that is,
older conversations
23.0
Conversation Unread Count
Property
Type
Description
Since Version
hasMore
Boolean
true if the actual number of unread
conversations is greater than 50, false
otherwise
23.0
unreadCount
Integer
Number of unread conversations, that is,
conversations that have unread messages. Is
an exact value up to the maximum of 50, and
is capped at 50 if the value is greater.
23.0
Error Message
Property
Type
Description
Since Version
errorCode
String
An error code with information about the error, for example,
INSUFFICIENT_PRIVILEDGES.
23.0
message
String
Description of error
23.0
Error With Output
Property
Type
Description
Since Version
message
String
Description of the error
27.0
output
Any response body
The response body described in the requested
resource. For example, if a successful request returns
a Like response body but an error triggers the Error
With Output response body, the value of the
output property is a Like response body.
27.0
225

Chatter API Resource Returns
Response Bodies
Explanation Details
Property
data
Type
Various
Description
More information about the recommendation. What is 24.0
returned depends on the type.
• UserFollowsSameUsers–people that both the user and
recommended person are following. See User Summary.
• GroupMembersFollowed–people that the user is
following and that are members of the recommended
group. See User Summary.
• UserViewingSameRecords—records that the user and
the recommended person have recently viewed. See Record
Summary.
• RecordParentOfFollowed—records that the user is
following and that are child records of the recommended
record. See Record Summary.
Since Version
summary
String
Explanation of recommendation
24.0
type
String
Type of recommendation explanation. Values are:
• UserFollowsSameUsers
• GroupMembersFollowed
• UserViewingSameRecords
• RecordParentOfFollowed
24.0
Explanation Summary
Property
Type
Description
Since Version
detailsUrl
String
URL for explanation details. If the
recommendation doesn’t have a detailed
explanation, the string “null”.
24.0
summary
String
Explanation of recommendation
23.0
type
String
Type of recommendation explanation, such
as UserFollowsSameUsers.
24.0
Favorite
Property
Type
Description
Since Version
community
Reference
Information about the community. Returns
null if favorite exists in default community
or communities aren’t enabled.
26.0
Note: Communities are available as
a pilot program.
226

Chatter API Resource Returns
Response Bodies
Property
createdBy
feedUrl
id
lastViewDate
name
searchText
type
Type
User Summary
String
String
String
String
String
String
Description
Information about the original creator of the
favorite
URL to the feed item for this favorite
18-character Id of the favorite
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
Name of the favorite
If the favorite is from a search, contains the
search text, if not, an empty string
An empty string or one of the following values:
• listView
• search
Since Version
24.0
24.0
24.0
24.0
24.0
24.0
24.0
url
String
URL to this favorite
24.0
user
User Summary
Information about the user who saved this
favorite
24.0
Favorites Page
Property
Type
Description
Since Version
favorites
Favorite[]
Collection of one or more favorites
24.0
total
Integer
Total number of favorites
24.0
Features
Property
Type
chatter Boolean
chatterActivity Boolean
chatterGlobalInfluence Boolean
chatterMessages Boolean
chatterTopics Boolean
dashboardComponentSnapshots Boolean
feedPolling Boolean
files
Boolean
filesOnComments Boolean
trendingTopics Boolean
Description
Specifies whether Chatter is enabled for an organization or not.
Specifies whether the user details include information about Chatter
activity
Specifies whether the user details include global Chatter activity
Specifies whether Chatter messages are enabled for the organization
Reserved for the Chatter topics pilot
Specifies whether the user can post dashboard component snapshots
Specifies whether the is-modified resource is enabled for the Chatter
API
Specifies whether files can act as resources for Chatter API
Specifies whether files can be attached to comments
Specifies whether trending topics are enabled
Since Version
27.0
24.0
24.0
24.0
26.0
24.0
24.0
24.0
24.0
24.0
227

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
viralInvitesAllowed
Boolean
Specifies whether existing Chatter users can invite people in their
company to use Chatter
24.0
Feed
Property
Type
Description
Since Version
feedItemsUrl
String
URL of feed items
23.0
isModifiedUrl
String
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.
23.0
Feed Body
Property
Type
Description
Since Version
messageSegments
Segment[]
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: Link
• Message Segment: Mention
• Message Segment: More Changes
• Message Segment: Text
23.0
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.
23.0
Feed Directory
Property
Type
Description
Since Version
favorites
Favorite[]
Collection of favorites that the logged-in user
has saved.
24.0
feeds
Feed Directory Item[]
Collection of feed directory items that the
logged-in user is allowed to view
23.0
228

Chatter API Resource Returns
Response Bodies
Feed Directory Item
Property
Type
Description
Since Version
feedItemsUrl
String
URL to the resource of the feed items for a specific
feed. For example:
23.0
/services/data/v27.0/
chatter/feeds/files/me/feed-items
feedUrl
String
URL to the resource of a specific feed. For example:
23.0
/services/data/v27.0/
chatter/feeds/files/me
label
String
Name of the feed, such as, Groups, People, Company,
and so on.
23.0
Feed Item
The type property always returns all types, regardless of version. However, not all types are valid with all versions. Use the
attachment property to verify the type of feed item. For example, for a type of PollPost, if the version is earlier than
26.0, attachment is null. Use the text property to properly render any unknown feed item types.
Property
Type
Description
Since Version
actor
Depends on parent
The entity that created the feed item. Values are:
• Record Summary—if a record (V23.0)
• User Summary—if a user (V23.0)
Note: If the actor is a user, a User Summary
response body is returned, not a Record
Summary of type user.
attachment
body
canShare
Depends on type
Feed Body
Boolean
Depends on the type value of the attachment. Values
include:
• Approval—Feed Item Attachment: Approval
(v27.0)
• BasicTemplate—Feed Item Attachment: Basic
Template (v27.0)
• Content—Feed Item Attachment: Content or null
if the content is unavailable (v23.0)
• Link—Feed Item Attachment: Link (v23.0)
• Poll—Feed Item Attachment: Poll (v26.0)
All other types return null.
Information about the feed item
true if feed item can be shared, false otherwise
23.0
27.0
229

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
clientInfo
ClientInfo
Information about the Connected App used to
authenticate the connection
23.0
comments
Comment Page
Comments for this feed item
23.0
createdDate
String
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
23.0
currentUserLike
Reference
Note: This property is no longer available as
of version 24.0. Use the myLike property
instead.
23.0–24.0
A reference to a like object if applicable, nullotherwise.
event
id
isBookmarkedByCurrentUser
isDeleteRestricted
isLikedByCurrentUser
likes
likesMessage
myLike
modifiedDate
originalFeedItem
originalFeedItemActor
Boolean
String
Boolean
Boolean
Boolean
Like Page
Like Message Body
Reference
String
Reference
Depends on type
true if feed item created due to an event change, false
otherwise
18-character Id of the feed item
true if the current user has bookmarked this feed item,
false otherwise.
Returns true if a feed item cannot be deleted by the
logged in user. If it returns false, possibly the logged
in users can delete the feed item.
true if the current user has liked this feed item, false
otherwise
Likes for this feed item
A message body that describes who likes the feed item.
If the logged-in user has liked the comment, this
property is a reference to the specific like, null otherwise
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
A reference to the original feed item if this feed item is
a shared feed item, null otherwise.
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
• null if this feed item is not a shared feed item
23.0
23.0
24.0
25.0
23.0
23.0
27.0
23.0
23.0
24.0
24.0
parent
Depends on type
Value depends on type of parent. Values are:
• File–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
23.0
230

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
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.
photoUrl
preamble
type
String
Feed Item Preamble
Message Body
String
URL of the photo associated with the feed item
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”.
Values are:
• ActivityEvent
• ApprovalPost
• AttachArticleEvent
• BasicTemplateFeedItem
• ChatTranscriptPost
• ContentPost
• EmailMessageEvent
• FacebookPost
• LinkPost
• PollPost
• RypplePost
• ReplyPost
• TextPost
• TrackedChange
• TwitterPost
• UserStatus
23.0
27.0
23.0
url
String
URL to this feed item
23.0
visibility
String
Who can see this feed item. Values are:
• InternalUsers
• AllUsers
26.0
Feed Item Attachment: Approval
Property
Type
Description
Since Version
id
String
The work item ID.
27.0
status
String
The status of the approval. Values are:
• Approved
• Fault
• Held
• NoResponse
• Pending
27.0
231

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
• Reassigned
• Rejected
• Removed
• Started
Feed Item Attachment: Basic Template
Property
Type
Description
Since Version
description
String
An optional description with a 500 character limit.
27.0
icon
Icon
An optional icon.
27.0
linkUrl
String
An optional link URL to a detail page if available
content can’t display inline.
27.0
subtype
String
The subtype associated with the basic template feed
item. Value is:
• CollaborationGroupCreated
27.0
title
String
An optional title to a detail page.
27.0
Feed Item Attachment: Content
Property
checkSum
description
downloadUrl
fileExtension
fileSize
fileType
hasImagePreview
hasPdfPreview
id
isInMyFileSync
mimeType
renditionUrl
Type
String
String
String
String
String
String
Boolean
Boolean
String
Boolean
String
String
Description
MD5 checksum for the file
Description of the attachment
URL to the content
Extension of the file
Size of the file in bytes. If size cannot be determined,
returns unknown.
Type of file
true if the file has a preview image available, false
otherwise
true if the file has a PDF preview available, false
otherwise
18-character Id of the content
Reserved for future use.
MIME type content of the file.
URL to the rendition resource for the file. Renditions
are processed asynchronously and may not be available
immediately after the file has been uploaded.
Since version
26.0
23.0
23.0
26.0
23.0
23.0
23.0
23.0
23.0
26.0
23.0
26.0
232

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since version
title
String
Title of the file
23.0
versionId
String
Version Id of the file
23.0
Feed Item Attachment: Link
Property
Type
Description
Since Version
title
String
Description of the link
23.0
url
String
URL attached to the feed item (could be external)
23.0
Feed Item Attachment: Poll
Property
Type
Description
Since Version
choices
Feed Poll Choice[]
Collection of feed poll choices that make up the
poll.
26.0
myChoiceId
String
18-character Id of the poll choice that the current
user has voted for in this poll. Returns null if the
current user hasn’t voted.
26.0
totalVoteCount
Integer
Total number of votes cast on the feed poll item.
26.0
Feed Item Page
Property
Type
Description
Since Version
currentPageUrl
String
URL to the first page of feed items
23.0
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.
27.0
isModifiedUrl
String
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.
23.0
items
Feed Item[]
Collection of one or more feed
items
23.0
nextPageUrl
String
URL to the next page of feed items
23.0
233

Chatter API Resource Returns
Response Bodies
Feed Item Preamble Message Body
Property
Type
Description
Since Version
messageSegments
Segments[]
Collection of message segments,
based on type. Segments can be
one or more of the following:
• Message Segment: Entity Link
• Message Segment: Text
27.0
text
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”.
27.0
Feed Modified Info
Property
Type
Description
Since Version
isModified
Boolean
true if a news feed and has been 23.0
modified since the last time it was
polled, false otherwise. Returns
null if the feed is not a news feed.
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.
27.0
nextPollUrl
String
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.
23.0
Feed Poll Choice
Property
Type
Description
Since Version
id
String
18-character Id of the poll choice
26.0
position
Integer
The location in the poll where this poll choice
exists. The first poll choice starts at 1.
26.0
text
String
Label text associated with the poll choice
26.0
234

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
voteCount
Integer
Total number of votes for this poll choice
26.0
voteCountRatio
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.
26.0
File
For all rendition properties, note the following: Renditions are processed asynchronously and may not be available immediately
after the file has been uploaded.
Property
Type
Description
Since Version
checkSum
String
MD5 checksum for the file
26.0
contentSize
Integer
Size of the file in bytes
24.0
contentUrl
String
If the file is a link, returns the URL, otherwise the
string “null”
24.0
description
String
Description of the file
24.0
downloadUrl
String
URL to the file
26.0
fileExtension
String
Extension of the file
26.0
fileType
String
Type of file, such as PDF, PowerPoint, and so on
24.0
flashRenditionStatus
String
Specifies if a flash preview version of the file has
been rendered
24.0
id
String
18-character Id of the file
24.0
isInMyFileSync
Boolean
Reserved for future use.
26.0
mimeType
String
File’s MIME type
26.0
modifiedDate
String
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
24.0
motif
Motif
Small, medium, and large icons indicating that the
object is a file:
27.0
"motif": {
"largeIconUrl":
"/img/content/content64.png",
"mediumIconUrl":
"/img/content/content32.png",
"smallIconUrl":
"/img/icon/files16.png"
}
The icon is not a preview of the file.
mySubscription
Reference
If the logged in user is following this file, this
contains information about the subscription,
otherwise returns null.
23.0
235

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
origin
String
Specifies the file source. Valid values are:
• Chatter—file came from Chatter
• Content—file came from content
• FileField—file came from a record or other
form
24.0
owner
User Summary
Owner of the file
24.0
name
String
Name of the file
24.0
pdfRenditionStatus
String
Specifies if a PDF preview version of the file has
been rendered
24.0
renditionUrl
String
URL to the rendition resource for the file.
Renditions are processed asynchronously and may
not be available immediately after the file has been
uploaded.
26.0
thumb120By90RenditionStatus
String
Specifies if a 120x90–pixel–sized preview image of
the file has been rendered.
24.0
thumb240By180RenditionStatus
String
Specifies if a 240x180–pixel–sized preview image of
the file has been rendered.
24.0
thumb720By480RenditionStatus
String
Specifies if a 720x480–pixel–sized preview image of
the file has been rendered.
24.0
title
String
Title of the file
24.0
type
String
ContentDocument
24.0
url
String
URL for the file
24.0
versionNumber
String
Version number of the file
24.0
File Details
Includes all of the File response body with the additional item:
Property
Type
Description
Since Version
pageCount
Integer
Number of pages for documents 24.0
that support flash renditions, or
the number of slides in a
presentation. Returns 0 if the flash
rendition fails, or if it isn’t
supported for the file type.
File Page
Property
Type
Description
Since Version
currentPageUrl
String
URL for the first page of files
24.0
236

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
files
File[]
Collection of one or more files
24.0
nextPageUrl
String
URL for the next page of files
24.0
previousPageUrl
String
URL for the previous page of files
24.0
File Shares Page
Property
Type
Description
Since Version
currentPageUrl
String
URL for the first page of file shares
24.0
shares
Shares[]
Collection of one or more file shares
24.0
nextPageUrl
String
URL for the next page of file shares
24.0
previousPageUrl
String
URL for the previous page of file shares
24.0
Flat Feed
Property
Type
Description
Since Version
currentPageUrl
String
URL for the first page of items
25.0–26.0
items
Flat Feed Item[]
Collection of one or more flat feed items
25.0–26.0
nextPageUrl
String
URL for the next page of items
25.0–26.0
Flat Feed Item
Property
Type
Description
Since Version
item
Depends on type
The flat feed item, depending on the value of
type. Valid values are:
• If type is Comment—Comment
• If type is FeedItem—Feed Item
25.0–26.0
type
String
The type of item. Valid values are:
• Comment
• FeedItem
25.0–26.0
Follower Page
Property
Type
Description
Since Version
currentPageUrl
String
URL to the current page
23.0
followers
Subscription[]
Collection of one or more followers or
subscriptions
23.0
237

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
mySubscription
Reference
Note: This field is no longer
available as of version 24.0.
23.0–24.0
If the logged-in user is following this user,
this contains information about the
subscription, else returns null
nextPageUrl
String
URL to the next page
23.0
previousPageUrl
String
URL to the previous page
23.0
total
Integer
Total number of followers
23.0
Following Counts
Property
Type
Description
Since Version
people
Integer
Number of people user is following
23.0
records
Integer
Number of records user is following
23.0
total
Integer
Total number of items user is following
23.0
Following Page
Property
Type
Description
Since Version
currentPageUrl
String
URL to the current page
23.0
following
Subscription[]
Collection of one or more subscriptions
23.0
nextPageUrl
String
URL of the next page
23.0
previousPageUrl
String
URL of the previous page
23.0
total
Integer
Total number of records being followed
23.0
Group
Property
Type
Description
Since Version
canHaveChatterGuests
Boolean
true if this group allows Chatter customers,
false otherwise
23.0
community
Reference
Information about the community. Returns null
if group exists in the default community or
communities aren’t enabled.
26.0
description
String
Text-only description of the group
23.0
fileCount
Integer
Number of files posted to this group.
24.0
id
String
18-character Id of the group
23.0
238

Chatter API Resource Returns
Response Bodies
Property
lastFeedItemPostDate
memberCount
motif
Type
String
Integer
Motif
Description
Date of the most recent feed item posted to the
group.
Total number of group members
Small, medium, and large icons indicating that the
object is a group:
"motif": {
"largeIconUrl":
"/img/icon/groups64.png",
"mediumIconUrl":
"/img/icon/groups32.png",
"smallIconUrl":
"/img/icon/groups16.png"
}
The icon is not the group photo.
Since Version
24.0
23.0
27.0
myRole
String
Values are:
• GroupOwner
• GroupManager
• NotAMember
• NotAMemberPrivateRequested
• StandardMember
23.0
mySubscription
Reference
If the logged-in user is a member of this group,
this contains information about that subscription,
or returns null otherwise.
23.0
name
String
Name of the group
23.0
owner
User Summary
Information about the owner of the group.
24.0
photo
Photo
Information about the group photo
23.0
type
String
CollaborationGroup.
23.0
url
String
Relative URL string to the group
23.0
visibility
String
Values are:
• PrivateAccess
• PublicAccess
23.0
Group Chatter Settings
A user’s Chatter settings for a specific group.
Property
Type
Description
Since Version
emailFrequency
String
The frequency with which a group member receives email
from a group. One of the following values:
• EachPost
• DailyDigest
27.0
239

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
• WeeklyDigest
• Never
• UseDefault
The value UseDefault uses the user’s default global
setting defined in User Chatter Settings.
Group Member
Property
Type
Description
Since Version
id
String
18-character Id of the group membership.
23.0
role
String
Values are:
• GroupOwner
• GroupManager
• NotAMember
• NotAMemberPrivateRequested
• StandardMember
23.0
url
String
URL to this membership
23.0
user
User Summary
Information about the user who is subscribed to this
group
23.0
Group Member Page
Property
Type
Description
Since Version
currentPageUrl
String
URL to this page of members
23.0
members
Group Member[]
Collection of group members
23.0
myMembership
Reference
If the logged-in user is a member of this group,
returns information about that membership, or
returns null otherwise
23.0
nextPageUrl
String
URL to the next page of members
23.0
previousPageUrl
String
URL to the previous page of members
23.0
totalMemberCount
Integer
Total number of group members
23.0
Group Membership Request
Property
Type
Description
Since Version
createdDate
String
An ISO formatted date string specifying the date
of the membership request.
27.0
id
String
ID for the group membership request object
27.0
240

Chatter API Resource Returns
Response Bodies
Property
groupRequest
lastUpdateDate
responseMessage
Type
Reference
String
String
Description
Information about the group the user is requesting
to join.
An ISO formatted date string specifying the last
time the request was updated.
A message to display to the user if their membership
request is declined. The value of this property is
used only when the value of the status property
is Declined.
The maximum length is 756 characters.
Since Version
27.0
27.0
27.0
status
String
The status of the request to join a private group.
Values are:
• Accepted
• Declined
• Pending
27.0
url
String
URL to this group membership request object
27.0
user
User Summary
Information about the user requesting membership
in a group.
27.0
Group Membership Request Collection
Property
Type
Description
Since Version
requests
Group Membership
Request
Information about all requests to join a private
group.
27.0
total
Integer
The total number of requests to join a private group.
27.0
Group Page
Property
Type
Description
Since Version
currentPageUrl
String
URL to this page of groups
23.0
groups
Group[]
Collection of groups
23.0
nextPageUrl
String
URL to the next page of groups
23.0
previousPageUrl
String
URL to the previous page of groups
23.0
Icon
Property
Type
Description
Since Version
height
Integer
The height of the icon, in pixels.
27.0
width
Integer
The width of the icon, in pixels.
27.0
241

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
url
String
The URL of the icon. This URL is available to
unauthenticated users. The URL doesn’t expire.
27.0
Influence Thresholds
Property
Type
Description
Since Version
name
String
Description of this influencer category. For example:
Active Influencer
24.0
threshold
Double
Number expressed as a raw percentile that defines the
bottom threshold for this influencer category. For
example: 0.25 defines the cutoff for the Active
Influencer category, which means it includes users
with an influence rank equal to or greater than the 25th
percentile (25%) and less than the next highest category
threshold.
24.0
Library
Property
Type
Description
Since Version
id
String
18-character Id of the library
24.0
name
String
Name of the library
24.0
type
String
Type of library, for example, ContentWorkspace
24.0
url
String
URL to this library
24.0
Like
Property
Type
Description
Since Version
id
String
18-character Id of the like on either a comment or a feed
item
23.0
likedItem
Reference
A reference to the liked comment or feed item.
27.0
url
String
URL to this like
23.0
user
User Summary
Information about the user who liked this comment or feed
item
23.0
Like Message Body
Property
Type
Description
Since Version
messageSegments
Segments[]
Collection of message segments, based on type. Segments can
be one or more of the following:
• Message Segment: Entity Link
27.0
242

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
• Message Segment: Resource Link
• Message Segment: Text
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.”
27.0
Like Page
Property
Type
Description
Since Version
currentPageUrl
String
URL to the current page of likes
23.0
likes
Like[]
Collection of likes
23.0
myLike
Reference
Note: This field is no longer available as
of version 24.0.
23.0–24.0
Either returns a reference to the specific like or
returns null
nextPageUrl
String
URL to the next page of likes
23.0
previousPageUrl
String
URL to the previous page of likes
23.0
total
Integer
Total number of likes for the item
23.0
Message
Property
body
conversationId
conversationUrl
id
recipients
Type
Feed Body
String
String
String
User Summary[]
Description
Text of this message
18-character Id of the conversation
this message is part of
URL to the conversation this message
is part of
18-character Id of the message
Collection of one or more message
recipients
Note: The collection of
recipients is empty for the
following resources because
the conversation participants
are already identified in the
conversation’s members
property in Conversation
Since Version
23.0
23.0
23.0
23.0
23.0
243

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
Detail and Conversation
Summary.
• /chatter/users/me/
conversations
• /chatter/users/me/
conversations/
conversationId
sentDate
String
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
23.0
sender
User Summary
Information about the user who sent
this message
23.0
url
String
URL to this message
23.0
Message Collection
Property
Type
Description
Since Version
currentPageUrl
String
URL to the first page of messages, that is, the most recent
messages
23.0
messages
Message[]
Collection of one or more messages
23.0
nextPageUrl
String
URL to the next page of messages, that is, older messages
23.0
Message Segment: Entity Link
Represents an inline link to a URL. The URL is an object, such as a record or a group.
Available in versions 25.0 and later.
Property
Type
Description
Since Version
motif
Motif
A set of small, medium, and large icons that correspond to the
entity type.
27.0
reference
Reference
Information about the link
25.0
text
String
Plain text output for this segment
25.0
type
String
EntityLink
25.0
244

Chatter API Resource Returns
Response Bodies
Message Segment: Field Change
Represents an inline field change, for example, "First Name from Bob to Joe". This segment can consist of multiple
segments, for example:
[
]
Text("Owner from "),
FieldChangeValue("Bob Smith"),
Text(" to "),
FieldChangeValue("Dave Jones")
Property
Type
Description
Since Version
segments
Segments[]
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: Link
• Message Segment: Mention
• Message Segment: More Changes
• Message Segment: Text
23.0
text
String
Formatted text of the change. For example:
23.0
"City from San Francisco to
New Orleans"
type
String
Value is FieldChange
23.0
Message Segment: Field Change Name
Represents an inline name of a field change, like “Name” or “Description.” Making this a separate segment makes it possible
to give special user interface treatments to field names, for example, making a name field bold.
Property
Type
Description
Since Version
text
String
Formatted text of the change. Possible values include:
• the old name of the field
• the new name of the field
23.0
type
String
Value is FieldChangeName
23.0
Message Segment: Field Change Value
Represents an inline value of a field change, like "1" or "Bob Smith.” Making this a separate segment makes it possible to add
special coding, for example, to wrap values in anchor tags.
245

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
text
String
Formatted text of the change. Possible values include:
• the words a blank value
23.0
Note: This text is also localized.
• the old value of the field
• the new value of the field
type
String
Value is FieldChangeValue
23.0
url
String
URL value if the field change is to a URL field (such as a
web address)
23.0
Message Segment: Hashtag
Represents an inline hashtag.
Property
Type
Description
Since Version
tag
String
Text of the hashtag without the hash symbol (#)
23.0
text
String
Text of the hashtag with the hash symbol (#)
23.0
type
String
Value is Hashtag
23.0
url
String
URL search for the tag in this format:
23.0
/feed-items?q=tag
Message Segment: Link
Represents an inline link to a URL
Property
Type
Description
Since Version
text
String
Formatted text of the feed item of this segment
23.0
type
String
Value is Link
23.0
url
String
URL value of the link
23.0
Message Segment: Mention
Represents an inline @mention.
Property
Type
Description
Since Version
accessible
Boolean
Specifies whether the mentioned user would be able to see
mention when it was posted: true if the mentioned user
could see the post, false otherwise
23.0
246

Chatter API Resource Returns
Response Bodies
Property
name
text
type
user
Type
String
String
String
User Summary
Description
Name of the user mentioned
Formatted text of the feed item of this segment
Value is Mention
Information about the mentioned user, null if the logged-in
user doesn’t have access.
Since Version
23.0
23.0
23.0
23.0
Message Segment: More Changes
In feed items with a large number of tracked changes, the message is formatted as: "changed A, B, and made 3 more changes."
The more changes segment contains the "3 more changes."
Property
Type
Description
Since Version
moreChangesCount
Integer
Number of other changes
23.0
text
String
Formatted text of the number of changes. For example: "2
other changes"
23.0
Note: This value is localized.
type
String
Value is MoreChanges
23.0
Message Segment: Resource Link
Property
Type
Description
Since Version
text
String
Formatted text of this segment
23.0
type
String
Value is "ResourceLink"
23.0
url
String
URL value of the resource link
27.0
Message Segment: Text
Represents plain inline text.
Property
Type
Description
Since Version
text
String
Formatted text associated with the item. Possible values
include:
• formatted text of a comment
• the name of the field that has been changed with the
word from
23.0
type
String
Value is Text
23.0
247

Chatter API Resource Returns
Response Bodies
Motif
Each property in the motif response body contains a URL to a small, medium, or large icon that indicates the Database.com
record type. Common record types in Chatter 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.
Note: 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": {
"largeIconUrl": "/img/icon/custom51_100/boat64.png",
"mediumIconUrl": "/img/icon/custom51_100/boat32.png",
"smallIconUrl": "/img/icon/custom51_100/boat16.png"
},
Users use the following icons:
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
Groups use the following icons:
"motif": {
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},
Files use the following icons:
"motif": {
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png"
},
Note: To view the icons in the previous examples, preface the URL with https://instance_name. For example,
https://instance_name/img/icon/profile64.png.
Property
Type
Description
Since Version
largeIconUrl
String
A large icon indicating the record type.
27.0
mediumIconUrl
String
A medium icon indicating the record type.
27.0
smallIconUrl
String
A small icon indicating the record type.
27.0
248

Chatter API Resource Returns
Response Bodies
Organization
Property
Type
Description
Since Version
accessTimeout
Integer
Amount of time after which the system prompts users who
have been inactive to log out or continue working
24.0
features
Features
Information about features available in the organization
24.0
name
String
Organization name
26.0
orgId
String
18-character Id for the organization
24.0
userSettings
User Settings
Information about the organization permissions for the
user
24.0
Organization Summary
Property
Type
Description
Since Version
name
String
Organization name
26.0
orgId
String
18-character Id for the organization
24.0
Parent
Property
Type
Description
Since Version
id
String
18-character Id of the parent
23.0
url
String
URL of the parent
23.0
Phone Number
Property
Type
Description
Since Version
number
String
Phone number
23.0–26.0
Important: This parameter is not supported after
version 26.0. Use phoneNumber instead.
phoneNumber
String
Phone number
27.0
type
String
Values are:
• Fax
• Mobile
• Work
23.0
249

Chatter API Resource Returns
Response Bodies
Photo
Property
fullEmailPhotoUrl
largePhotoUrl
photoVersionId
smallPhotoUrl
standardEmailPhotoUrl
url
Type
String
String
String
String
String
String
Description
A temporary URL to the large profile picture that expires
after 30 days. This URL is available to unauthenticated users.
URL to the large profile picture. The default width is 200
pixels, while the length is scaled so the original image
proportions are maintained.
18-character Id to that version of the photo.
URL to the small profile picture. The default size is 64x64
pixels.
A temporary URL to the small profile picture that expires
after 30 days. This URL is available to unauthenticated users.
URL to a resource that returns a Photo response body: for
example,
/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo.
Since
Version
27.0
23.0
24.0
23.0
27.0
27.0
Recommendation
Property
Type
Description
Since Version
action
String
The recommended action. Values are:
• follow (V23.0)
• join (V23.0)
• view (V25.0)
actOnUrl
String
URL that can be used with an HTTP method
POST request to follow a recommended user, file,
or record, or join a recommended group. For
example:
23.0
/users/me/following/
?subjectId=001D000000Iyu2p
explanation
Explanation
Summary
The recommendation explanation
23.0
object
Various
The object with which the receiver is recommended
to take action. Possible objects are:
• File (V24.0)
• Group (V23.0)
• Record Summary (V23.0)
• User Summary (V23.0)
type
String
No longer available as of version 24.0
23.0–24.0
250

Chatter API Resource Returns
Response Bodies
Record Summary
Property
Type
Description
Since Version
id
String
18-character Id of the record
23.0
motif
Motif
Small, medium, and large icons
indicating the tab style of the record.
There are many tab styles. The following
URLs are for the “boat” tab style:
27.0
"motif": {
"largeIconUrl":
"/img/icon/custom51_100/boat64.png",
"mediumIconUrl":
"/img/icon/custom51_100/boat32.png",
"smallIconUrl":
"/img/icon/custom51_100/boat16.png"
}
mySubscription
Reference
If the logged in user is following this
record, this contains information about
the subscription, otherwise returns null.
24.0
name
String
Formatted display name
23.0
type
String
Type of record, such as CustomObject,
ContentDocument, and so on
23.0
url
String
Relative URL to this record
23.0
Reference
Property
Type
Description
Since Version
id
String
18-character Id of the object being referenced
23.0
url
String
URL to the resource endpoint
23.0
Shares
Property
Type
Description
Since Version
entity
Depends on
sharing
Returns information about the user, record, or group the file
is shared with. Value is one of the following:
• Group
• Record Summary
• User Summary
• Library
24.0
251

Chatter API Resource Returns
Response Bodies
Property
sharingType
Type
String
Description
The permission level of sharing. Values are:
24.0
• C—collaborator
• I—sharing permission is determined by location. This
generally occurs when the sharing permission is not set
on the file, but on the library instead. This value is also
used when the logged-in user is the same as owner of the
file.
• N—no access
• V—viewer
Since Version
Subscription
Property
Type
Description
Since Version
community
Reference
Information about the community. Returns null if subscription
exists in default community or communities aren’t enabled.
26.0
Note: Communities are available as a pilot program.
id
String
18-character Id of the subscription
23.0
subject
Depends
Information about the parent, that is, the thing or person being
followed. Valid values are:
• Group
• Record Summary
• User Summary
23.0
subscriber
Depends
Information about the subscriber, that is, the person following
this item. Valid values are:
• Group
• Record Summary
• User Summary
23.0
url
String
Relative URL to this specific subscription
23.0
Subscription Page
Property
Type
Description
Since Version
currentPageUrl
String
Returns the current page of subscriptions
23.0
nextPageUrl
String
Returns the next page of subscriptions. If there is no next page,
returns the string “null”
23.0
mySubscription
Reference
Returns information about the subscription, or null the
logged-in user is not subscribed.
23.0
252

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
previousPageUrl
String
Returns the previous page of subscriptions. If there is no
previous page, returns the string “null”
23.0
subscriptions
Subscription[]
Collection of subscriptions
23.0
total
Integer
Total number of subscriptions
23.0
Topics
Property
Type
Description
Since Version
name
String
Name of the topic
24.0
User Chatter Settings
A user’s global Chatter settings.
Property
Type
Description
Available Since
defaultGroupEmailFrequency
String
The default frequency with which a user receives email from
a group when they join it. Values are:
• EachPost
• DailyDigest
• WeeklyDigest
• Never
27.0
User Detail
See Is User Summary or User Detail Returned? for information about when this response body is returned.
Property
Type
Description
Since Version
aboutMe
String
Text from user's profile
23.0
address
Address
Address
23.0
chatterActivity
Chatter Activity
Chatter activity statistics
23.0
chatterInfluence
Chatter Influence
User’s influence rank
23.0
companyName
String
Company name
23.0
currentStatus
User Status
Note: This property is no longer available
as of version 25.0.
23.0–25.0
User's current status
email
String
User's email address
23.0
firstName
String
User's first name
23.0
followersCount
Integer
Number of users following this user
23.0
253

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
followingCounts
Following Counts
Information about items the user is following
23.0
groupCount
Integer
Number of groups user is following
23.0
id
String
18-character Id of the user
23.0
isActive
Boolean
true if user is active, false otherwise
23.0
isChatterGuest
Boolean
Note: This property is no longer available
as of version 26.0. Use the userType
property instead.
23.0–25.0
true if user is a Chatter customer, false otherwise
lastName
String
User's last name
23.0
managerId
String
18-character Id of the user’s manager
23.0
managerName
String
Locale-based concatenation of manager's first and
last names
23.0
motif
Motif
Small, medium, and large icons indicating that the
object is a user:
27.0
"motif": {
"largeIconUrl":
"/img/icon/profile64.png",
"mediumIconUrl":
"/img/icon/profile32.png",
"smallIconUrl":
"/img/icon/profile16.png"
}
The motif icon is not the user’s profile picture.
mySubscription
Reference
If the logged-in user is following this user, this
contains information about the subscription, else
returns null
23.0
name
String
Locale-based concatenation of user's first and last
names
23.0
phoneNumbers
Phone Number[]
Collection of user's phone numbers
23.0
photo
Photo
Information about the user's photos
23.0
title
String
Title of the user
23.0
type
String
User
23.0
url
String
URL to the user's profile
23.0
username
String
User name of the user, such as
Admin@mycompany.com.
24.0
userType
String
Type of user. Values are:
• ChatterGuest—User is a Chatter customer in
an external group
• Guest—Unauthenticated users
26.0
254

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
• Internal—User is a standard organization
member
• Portal—User is a Customer Portal User, a
communities user, and so on.
• System—User is Chatter Expert or a system
user
User Group Page
Property
Type
Description
Since Version
currentPageUrl
String
URL to the current page
23.0
groups
Group[]
Collection of groups for the logged-in user
23.0
nextPageUrl
String
URL to the next page, if there is no next page,
returns the string “null”
23.0
previousPageUrl
String
URL to the previous page, if there is no previous
page, returns the string “null”
23.0
User Page
Property
Type
Description
Since Version
currentPageUrl
String
URL to the current page
23.0
nextPageUrl
String
URL to the next page, if there is no next page,
returns the string “null”
23.0
previousPageUrl
String
URL to the previous page, if there is no previous
page, returns the string “null”
23.0
users
User Detail[]
Collection of user detail information.
24.0
User Settings
Property
Type
Description
Since Version
approvalPosts
Boolean
User can approve workflows from Chatter posts.
27.0
canFollow
Boolean
The logged-in user is allowed to follow things.
24.0
canModifyAllData
Boolean
User has “Modify all Data” permission
24.0
canOwnGroups
Boolean
User can own groups
24.0
canViewAllData
Boolean
User has “View all Data” permission
24.0
canViewAllGroups
Boolean
User has “View all Groups” permission
24.0
canViewAllUsers
Boolean
User has “View all Users” permission
24.0
canViewFullUserProfile
Boolean
User can see of other user’s Chatter profiles
24.0
255

Chatter API Resource Returns
Response Bodies
Property
Type
Description
Since Version
canViewPublicFiles
Boolean
User can see all files marked as public
24.0
externalUser
Boolean
User is a Chatter customer
24.0
hasAccessToInternalOrg
Boolean
User is a member of the internal organization
26.0
hasFileSync
Boolean
Reserved for future use
26.0
userId
String
18-character Id of the user
24.0
userLocale
String
Locale of user
24.0
User Status
Property
Type
Description
Since Version
body
Feed Body[]
Body of the post
23.0–25.0
parentId
String
18-character Id
23.0–25.0
url
String
URL to this user status post
23.0–25.0
User Summary
See Is User Summary or User Detail Returned? for information about when this response body is returned.
Property
Type
Description
Since Version
companyName
String
Name of the company
23.0
firstName
String
User's first name
23.0
id
String
18-character Id
23.0
isActive
Boolean
true if user is active, false otherwise.
25.0
isChatterGuest
Boolean
Note: This property is no longer available as
of version 26.0. Use the userType property
instead.
23.0–26.0
true if user is a Chatter customer, false otherwise
lastName
String
User's last name
23.0
motif
Motif
Small, medium, and large icons indicating that the object
is a user:
27.0
"motif": {
"largeIconUrl":
"/img/icon/profile64.png",
"mediumIconUrl":
"/img/icon/profile32.png",
"smallIconUrl":
"/img/icon/profile16.png"
},
The motif icon is not the user’s profile photo.
256

Chatter API Resource Returns
Response Bodies
Property
mySubscription
name
photo
title
type
url
userType
Type
Reference
String
Photo
String
String
String
String
Description
If the logged-in user is following this user, this contains
information about the subscription, else returns null
Locale-based concatenation of first and last names
Information about the user's photos
Title of the user
User
URL to the user's profile
Since Version
23.0
23.0
23.0
23.0
23.0
23.0
Type of user. Valid values are:
26.0
• ChatterGuest—User is a Chatter customer in an
external group
• Guest—Unauthenticated users
• Internal—User is a standard organization member
• Portal—User is a Customer Portal User, a
communities user, and so on.
• System—User is Chatter Expert or a system user
Is User Summary or User Detail Returned?
Whether a User Summary or a User Detail response body is returned depends on the resource that called it, as well as other
variables. The following table describes when which response body is returned.
Resource
Returns user information and is not either
/users and /users/userId (for
example, Batch Results returns a collection
of User Summary response bodies.)
/users and /users/userId
/users
/users and /users/userId
/users/userId
/users/userId
Version
All
All
All
25.0 or earlier
All
All
User Type
All
Internal user
Not internal user
Not internal user
Not internal user and userId
is not the current user
Not internal user and userId
is the current user
Response Body
User Summary
User Detail
User Summary
User Summary
User Summary
User Detail
See Also:
Chatter API Resource Returns
Response Body Filters
257

Chatter API Resource Returns
Response Body Filters
Response Body Filters
To filter the content of a response body, use the exclude or include query string parameter in a GET request. For example,
you may be creating a mobile application and want to keep response bodies as small as possible.
Exclude
To exclude specific properties from a response body, use the exclude query string parameter.
The value for the exclude query is a list of properties separated by bars (|). You must URL encode the bars as %7C. You
must include a forward slash before each property name.
The following request excludes both the aboutMe and address properties from a response body:
/chatter/users/me?exclude=/aboutMe%7C/address
The following table lists rules for using the exclude query parameter, as well as additional examples.
Description
Original Output
Exclude Value
Filtered Output
Include a forward
slash (/) before
property names or the
{
"bar" : "bar value",
"baz" : "baz value"
}
exclude=bar
400 error with error code
INVALID_FILTER_VALUE
258

Chatter API Resource Returns
Response Body Filters
Description
Original Output
Exclude Value
Filtered Output
request returns an
error.
Filter properties by
name.
{
"bar" : "bar value",
"baz" : "baz value"
}
exclude=/bar
{
"baz" : "baz
value"
}
Top-level properties
cannot be filtered.
Note that this query
string doesn’t return
an error.
bar value
baz value
exclude=/foo
bar value
baz value
Use a bar (|) delimiter
to filter multiple
properties. URL
encode the delimiter
as %7C.
{
"foo" : "foo value",
"bar" : "bar value",
"baz" : "baz value"
}
exclude=/foo%7C/bar
{
"baz" : "baz
value"
}
Filtering a response
body filters everything
in the response body.
bar value
baz value
sub 1
exclude=/someObject
bar value
baz value
To filter a property
nested in a response
body, include the
parent response body
name as a filter
segment.
bar value
baz value
sub value
exclude=/someObject/sub
bar value
baz value
Identify an item in a
list by its property
name. This example
uses XML.
bar valu
baz value
1
2
3
exclude=/someList/item/id
bar value
baz value
259

Chatter API Resource Returns
Response Body Filters
Description
Original Output
Exclude Value
Filtered Output
Identify an item in a
list by its property
name. This example
uses JSON.
{
"bar" : "bar value",
"baz" : "baz value",
"someList" : [
{
"id" : "1"
},
{
"id" : "2"
} ,
{
"id" : "3"
}
]
}
exclude=/someList/item/id
{
"bar" : "bar value",
"baz" : "baz value",
"someList" : [
{},
{},
{}
]
}
Include
To limit the response body to specific properties, use the include query string parameter.
The value for the include query string parameter is a list of properties separated by bars (|). You must URL encode the bars
as %7C. Include a forward slash before every property name.
The following request includes only the aboutMe property and the address property in a response body:
/chatter/users/me?include=/aboutMe%7C/address
The following table lists rules for using the include query parameter.
Description
Include a forward
slash (/) before
property names or the
Original Output
{
"bar" : "bar value",
"baz" : "baz value"
}
Include Value
include=bar
Filtered Output
400 error with error code
INVALID_FILTER_VALUE
260

Chatter API Resource Returns
Response Body Filters
Description
Original Output
Include Value
Filtered Output
request returns an
error.
Filter properties by
name.
{
"bar" : "bar value",
"baz" : "baz value"
}
include=/bar
{
"bar" : "bar
value",
}
Top-level properties
are ignored. Note
there is no error when
you try this.
bar value
baz value
include=/foo
bar value
baz value
Use a bar (|) delimiter
to filter multiple
properties. URL
encode the delimiter
as %7C.
{
"foo" : "foo value",
"bar" : "bar value",
"baz" : "baz value"
}
include=/foo%7C/bar
{
"foo" : "foo
value",
"bar" : "bar
value",
}
Filtering a response
body filters everything
below it.
bar value
baz value
sub 1
include=/someObject
sub 1
To filter a property
nested in a response
body, include the
parent response body
name as a filter
segment.
bar value
baz value
sub value
include=/someObject/sub
sub 1
Identify an item in a
list by its property
name. This example
uses XML.
bar valu
baz value
1
2
3
include=/someList/item/id
1
2
3
261

Chatter API Resource Returns
Response Body Encoding
Description
Original Output
Include Value
Filtered Output
Identify an item in a
list by its property
name. This example
uses JSON.
{
"bar" : "bar value",
"baz" : "baz value",
"someList" : [
{
"id" : "1"
},
{
"id" : "2"
} ,
{
"id" : "3"
}
]
}
include=/someList/item/id
{
"someList" : [
{
"id" : "1"
},
{
"id" : "2"
} ,
{
"id" : "3"
}
]
}
See Also:
Chatter API Resource Returns
Response Bodies
Response Body Encoding
Response Body Encoding
Chatter API serves user-submitted content that is often not filtered at input and may come from many different sources
including third-party mobile and web applications. Therefore, developers creating applications that consume Chatter API
output must take care to properly process the output for the context in which they use the data. Failing to do so may expose
their application and their users to Cross Site Scripting (XSS) exploits and other problems that may result in data loss,
application failure and exposure of confidential company information.
Chatter API strings are minimally HTML entity encoded by default, which is suitable in most cases for display between
HTML tags, but not necessarily in other HTML contexts.
Chatter API output may be used in many contexts. Developers should not assume that the default entity encoding is appropriate
for all contexts. In particular, using Chatter API output inside HTML attribute values, inside URLs, with javascript, inside
script tags and inside CSS all require different encoding and whitelisting. See the Open Web Application Security Project
for information on how to handle API output in different contexts.
Chatter API response returns are encoded on output. We escape the following characters in all strings:
Character
<
Escaped as
&lt;
262

Chatter API Resource Returns
Status Codes and Error Responses
Character
>
"
'
\
&
Escaped as
&gt;
&quot;
&#39;
&#92;
&amp;
For non-HTML contexts, such as native mobile applications, Chatter API clients may request raw (unencoded) output by
setting the X-Chatter-Entity-Encoding HTTP header in your request to false.
Chatter API does special encoding of any URL values included in response payloads. The main part of the URL is URL-encoded
as per RFC2396, and the query string is HTML-form encoded. This encoding cannot be turned off.
See Also:
Chatter API Resource Returns
Response Body Filters
Status Codes and Error Responses
Status Codes and Error Responses
Either when an errors occur, or a response is successful, the response header contains an HTTP code, and the response body
usually contains the HTTP response code, the message accompanying that error, and if appropriate, the field or object where
the error occurred.
HTTP Response Code
200
201
204
400
401
403
404
409
500
Description
Success with GET or HEAD request
Success with POST request
Success with DELETE
The request could not be understood, usually because of an invalid ID, such as a userId,
feedItemId, or groupId being incorrect.
The session ID or OAuth token used has expired or is invalid. The response body contains the
message and errorCode.
The request has been refused. Verify that the context user has the appropriate permissions to
access the requested data, or that the context user is not an external user.
Either the specified resource was not found, or the resource has been deleted.
A conflict has occurred. For example, an attempt was made to update a request to join a group,
but that request had already been approved or rejected.
An error has occurred within Force.com, so the request could not be completed. Contact
salesforce.com Customer Support.
263

Chatter API Resource Returns
Status Codes and Error Responses
HTTP Response Code
503
Description
Too many requests in an hour.
Examples
The following are examples of what is returned for errors.
• Incorrect ID:
Using a non-existent ID in a request using JSON or XML (request_body.json or request_body.xml)
{
}
"fields" : [ "Id" ],
"message" : "User ID: id value of incorrect type: 001900K0001pPuOAAU",
"errorCode" : "MALFORMED_ID"
• Resource does not exist:
Requesting a resource that does not exist, for example, you try to create a record using a misspelled object name
{
}
"message" : "The requested resource does not exist",
"errorCode" : "NOT_FOUND"
See Also:
Chatter API Resource Returns
Response Body Encoding
264

CONNECT IN APEX
Chapter 7
Getting Started with Connect in Apex
In this chapter ...
• When Should You Use Apex?
• Understanding Connect in Apex
• Primary Differences Between Chatter
REST API and Connect in Apex
• Testing Connect in Apex
• Map Relating Chatter API Resources
to Apex Methods
Note: Connect in Apex is currently available as a Developer Preview
in all Developer Editions. For information on enabling Connect in Apex
in other editions, contact salesforce.com.
In addition to using Chatter API as a REST API, you can also access the Chatter
API resources using Force.com Apex Code, Database.com’s premier programming
language.
Apex is a strongly typed, object-oriented programming language that allows
developers to execute flow and transaction control statements on Database.com
in conjunction with calls to the Force.com API. Using syntax that looks like Java
and acts like database stored procedures, Apex enables developers to add business
logic to most system events. Apex code can be initiated by Web service requests
and from triggers on objects.
This chapter contains the following:
• Understanding when to use Apex as opposed to REST.
• The key characteristics of Connect in Apex.
• The Connect in Apex reference material.
For more information about Apex, see the Force.com Apex Code Developer's Guide.
265

Getting Started with Connect in Apex
When Should You Use Apex?
When Should You Use Apex?
Chatter API as a REST API is generally used by third-party vendors or ISVs who want to create apps that integrate Chatter
data and third-party sites, or applications.
Use Connect in Apex when you’re developing native applications in Apex and Visualforce. Connect in Apex makes it easy to
post feed items with mentions, update user or group photos, or make social Visualforce pages.
See Also:
Getting Started with Connect in Apex
Understanding Connect in Apex
In Apex, it is possible to access some Chatter data using SOQL queries and objects. Connect in Apex exposes Chatter data
in a much simpler way. For example, instead of having to do many calls to access and assemble a feed, using Connect in Apex
you can do it with a single method call.
In Chatter REST API, Chatter data is exposed as resources addressed by URLs, which are arranged in a hierarchy, such as:
/chatter/groups/
/chatter/groups/groupId
/chatter/groups/groupId/members
And
/chatter/users/
/chatter/users/userId
/chatter/users/userId/followers
In Connect in Apex, Chatter data is exposed as objects in the ConnectApi namespace. These objects are passed in and
retrieved from calls to static methods found in the following classes:
Class Name
Chatter
ChatterFavorites
ChatterFeeds
ChatterGroups
Description
Use this class to access information about followers and
subscriptions for records.
Use this class to add, get, update, and delete Chatter favorites.
Use this class to access and modify feeds and feed data. This
includes accessing, adding, and deleting feed items, as well as
likes, comments, and bookmarks. You can also use this class
to search feed items.
Use this class to access information about groups, such as the
group’s members, photo, and the groups the specified user is
following. Also use this class to add members to a group,
remove members, and change the group photo.
266

Getting Started with Connect in Apex
Primary Differences Between Chatter REST API and Connect
in Apex
Class Name
ChatterUsers
Description
Use this class to access information about the user, such as
who is following the user, the user’s subscriptions, files, and
groups.
Note: At this time, not all of the Chatter API resources are available in Connect in Apex, for example, private
messaging, files, recommendations, and topics are not available.
Call static methods in these classes to retrieve Chatter data. For example, performing a GET against the following Chatter
REST API URL:
/chatter/groups/groupId
is equivalent to making the following Connect in Apex method call:
ConnectApi.ChatterGroups.getGroup(communityId, groupId);
You can also update Chatter data using Connect in Apex. This sort of method is the equivalent of a REST POST, PATCH,
or PUT. For example, the following adds a comment to the specified feed item:
ConnectApi.ChatterFeeds.postComment(null, '0D5B0000000KBeg', 'Text of comment');
As with a REST DELETE, if you call one of the Connect in Apex delete methods, if the item has already been deleted, you
won’t receive an exception.
When an organization tries to install a package that contains Connect in Apex code, it must have the correct permissions for
the package to install without error. For example, Connect in Apex is available only in editions where Apex is available. In
addition, Chatter must be enabled.
See Also:
Getting Started with Connect in Apex
Primary Differences Between Chatter REST API and Connect in Apex
Request bodies and parameters versus input classes
In Chatter REST API, you can specify either request parameters or a request body with the request, to add additional
information.
In Connect in Apex, methods take either simple or complex types. Simples types are primitive Apex data types that
correspond to Chatter API request parameters. Complex types are ConnectApi object data types that correspond to
Chatter REST API request bodies. Connect in Apex complex types are called input objects.
Response bodies versus response objects
In Chatter REST API, a successful request can return either an XML or JSON response body.
267

Getting Started with Connect in Apex
Primary Differences Between Chatter REST API and Connect
in Apex
In Connect in Apex, successful execution of a method can return an output object from the ConnectApi namespace.
ConnectApi output objects can be made up of other output objects. For example, ActorWithId contains simple
properties such as id and url, and also a sub-object, reference.
CommunityId Parameters
Note: Communities are available as a pilot program.
All Connect in Apex methods include communityId as the first parameter. Use null for this parameter.
If you specify null, URLs returned in the output use one of these formats:
/chatter/resource
/connect/resource
Transactional model
Apex follows a different model than REST. Using REST, when a request is successful, changes to the database are
applied immediately.
Apex uses a transactional model. All requests are delimited by the trigger, class method, Web Service, or anonymous
block that executes the Apex code. If the entire request completes successfully, all changes are committed to the database.
If the request does not complete successfully, all database changes are rolled back.
Governor Limits
Every Connect in Apex write operation costs 1 DML statement against the Apex governor limits.
Rate Limits
Connect in Apex method calls are subject to rate limiting. Connect in Apex rate limits match Chatter REST API rate
limits. Both have a per user, per namespace, per hour rate limit. Managed packages (which use namespaces) have their
own limits that are separate from the limits for code that doesn’t use a namespace.
When you exceed the rate limit, a ConnectApi.RateLimitException is thrown. Your Apex must catch and handle
this exception.
A call to the Apex Test.startTest method starts a new rate limit. A call to the Test.stopTest method sets your
rate limit to the value it was before you called Test.startTest.
Serialization and deserialization
JSON serialization of ConnectApi output objects produces JSON with the same structure as JSON returned fromChatter
API. JSON deserialization of ConnectApi input objects uses the same format as JSON deserialization in Chatter API.
Connect in Apex supports serialization and deserialization in the following Apex contexts:
• JSON and JSONParser classes—serialize Connect in Apex outputs to JSON and deserialize Connect in Apex inputs
from JSON.
• Apex REST with @RestResource—serialize Connect in Apex outputs to JSON as return values and deserialize
Connect in Apex inputs from JSON as parameters.
• JavaScript Remoting with @RemoteAction—serialize Connect in Apex outputs to JSON as return values and
deserialize Connect in Apex inputs from JSON as parameters.
268

Getting Started with Connect in Apex
Primary Differences Between Chatter REST API and Connect
in Apex
Connect in Apex follows these rules for serialization and deserialization:
• Only output objects can be serialized.
• Only top-level input objects can be deserialized. Currently, the only top-level objects that can be deserialized are
FeedItemInput and CommentInput.
• Enum values and exceptions cannot be serialized or deserialized.
System mode vs. context user
Unless otherwise specified, Apex runs in system mode, and the permissions, field-level security, and sharing rules of the
current user are not taken into account.
However, Connect in Apex code does not run in system mode. Like Chatter REST API, Connect in Apex methods
run under the context of the current user. What the current user has access to is what the code has access to.
When a user is specified with a method, frequently the subjectId must be the same as the context user. You can use
the string me to specify the context user instead of an Id.
User Summary vs. User Detail Outputs
Some methods typed to return ConnectApi.UserSummary objects may instead return instances of
ConnectApi.UserDetail. What gets returned depends on whether the context user is an internal user or not. You
can use the instanceof keyword to check the class at runtime. The following table describes which object type is
returned in various contexts:
Method
Returns user information and is not either
getUser or getUsers (for example,
searchUsers returns a collection of
UserSummary objects.)
getUser or getUsers
getUsers
getUser
getUser
User
Any
Internal user
Not internal user
Not internal user and userId is
not the current user
Not internal user and userId is
the current user
Object Type
UserSummary
UserDetail
UserSummary
UserSummary
UserDetail
Versioning
Versioning for Connect in Apex follows these rules:
• A Connect in Apex method call executes in the context of the version of the class that contains the method call. The
use of version is analogous to the /vXX.X section of a Chatter REST API URL.
• If a Connect in Apex method returns an output object, that object exposes a getBuildVersion method. This
method returns the version under which the method that created the output object was invoked.
• When interacting with input objects, Apex can access only properties supported by the version of the enclosing Apex
class.
269

Getting Started with Connect in Apex
Primary Differences Between Chatter REST API and Connect
in Apex
• Input objects passed to a Connect in Apex method may contain only non-null properties that are supported by the
version of the Apex class executing the method. If the input object contains version-inappropriate properties, an
exception is thrown.
• The toString method only returns properties that are supported in the version of the code interacting with the
object. For output objects, the returned properties must also be supported in the build version.
• Apex REST, JSON.serialize, and @RemoteAction serialization match Chatter REST API serialization, which
includes only version-appropriate properties.
• Apex REST, JSON.deserialize, and @RemoteAction deserialization match Chatter REST API deserialization,
which rejects properties that are version-inappropriate.
Equality
Casting
Equality checking for Connect in Apex follows these rules:
Input objects—properties are compared.
Output objects—properties and build versions are compared. For example, if two objects have the same properties with
the same values but have different build versions, the objects are not equal. To get the build version, call
getBuildVersion.
It may be useful to downcast some Connect in Apex output objects to a more specific type.
This technique is especially useful for message segments and feed item attachments. Message segments are typed as
ConnectApi.MessageSegment. Feed item attachments are typed as ConnectApi.FeedItemAttachment.
At runtime you can use instanceof to check the concrete types of these objects and then safely proceed with the
corresponding downcast. The following example downcasts a ConnectApi.MessageSegment to a
ConnectApi.MentionSegment:
(segment instanceof ConnectApi.MentionSegment) {
ConnectApi.MentionSegment = (ConnectApi.MentionSegment)segment;
}
Limitations Using Connect in Apex
The following are limitations when using Connect in Apex:
• with sharing and without sharing keyword—These keywords are ignored by Connect in Apex code. Instead, all
security, field level sharing, and visibility is controlled by the context user. For example, if a context user is a member of a
private group, Connect in Apex code can post to that group. If the context user is not a member of a private group, the
code can’t see the feed items for that group and cannot post to the group.
• Testing—Connect in Apex method calls generally require access to real organization data, and fail if used in test methods
not marked @IsTest(SeeAllData=true). Some Connect in Apex methods, such as getFeedItemsFromFeed,
getFeedItemsFromFilterFeed, and searchFeedItemsInFeed are not permitted to access organization data in
tests and must be used in conjunction with test methods that register values to be returned from these methods when
executed within test code.
• Some Connect in Apex operations are asynchronous, that is, they don’t occur immediately. For example, if your code adds
a feed item for a user, it is not immediately available in the news feed. Another example: when you add a photo, it is not
available immediately. For testing, this means that if you add a photo, you can’t retrieve it immediately.
• In Apex REST, XML serialization and deserialization of Connect in Apex objects is not supported.
270

Getting Started with Connect in Apex
Testing Connect in Apex
• Some Connect in Apex objects, such as FeedItem and other objects that overlap with sObject names, cannot currently
be used as attributes in Visualforce components. A possible workaround is to pass around other objects that wrap the
Connect in Apex objects.
• The log entries for Connect in Apex objects are currently empty. To get a serialization of version-appropriate properties
that can be used for logging, call toString on objects.
• Connect in Apex objects cannot be used in Apex SOAP Web services indicated with the keyword webservice.
See Also:
Getting Started with Connect in Apex
Testing Connect in Apex
Connect in Apex method calls generally require access to real organization data, and fail if used in test value registration
methods not marked @IsTest(SeeAllData=true). Some Connect in Apex methods, such as getFeedItemsFromFeed,
getFeedItemsFromFilterFeed, and searchFeedItemsInFeed are not permitted to access organization data in tests
and must be used in conjunction with special methods that register outputs to be returned in a test context.
Using Connect in Apex test methods is similar to testing Web services in Apex. First, build the data you expect the associated
get method to return. Then call the associated test method to register the data with a specific parameter combination. When
you run the get method associated with the test method, a value that was registered with the test method is returned.
The following shows which methods are associated with which test methods.
Get Method
getFeedItemsFromFeed
getFeedItemsFromFilterFeed
searchFeedItemsInFeed
Associated Test Method
setTestGetFeedItemsFromFeed
setTestGetFeedItemsFromFilterFeed
setTestSearchFeedItemsInFeed
Important: In a test, invoke these test methods only for parameter combinations that you have registered return
values with in test method calls. If a given parameter combination does not have a return value registered, you receive
an assertion.
The following example shows a test that constructs an ConnectApi.FeedItemPage and registers it to be returned when
getFeedItemsFromFeed is called with a particular combination of parameters.
global class TestController {
global static Integer getNewsFeedCount() {
ConnectApi.FeedItemPage items = ConnectApi.ChatterFeeds.getFeedItemsFromFeed(null,
}
ConnectApi.FeedType.News, 'me');
return items.items.size();
@IsTest
global static void doTest() {
// Build a simple feed item
ConnectApi.FeedItemPage testPage = new ConnectApi.FeedItemPage();
List testItemList = new List();
271

Getting Started with Connect in Apex
Map Relating Chatter API Resources to Apex Methods
}
}
testItemList.add(new ConnectApi.FeedItem());
testItemList.add(new ConnectApi.FeedItem());
testPage.items = testItemList;
// Set the test data
ConnectApi.ChatterFeeds.setTestGetFeedItemsFromFeed(null,
ConnectApi.FeedType.News, 'me', testPage);
// The method returns the test page, which we know has two items in it
System.assertEquals(getNewsFeedCount(), 2);
In tests, you are allowed to use no-argument constructors for any non-abstract output classes, and to set the properties on
these objects. This is useful for both testing your own code, and for making values to pass to these test methods.
See Also:
Getting Started with Connect in Apex
Map Relating Chatter API Resources to Apex Methods
The following maps Connect in Apex methods to the equivalent Chatter API resource and HTTP method.
Chatter API Resources
/chatter/records/recordId/followers
HTTP method: GET
/chatter/subscriptions/subscriptionId
HTTP method: DELETE
/chatter/subscriptions/subscriptionId
HTTP method: GET
/chatter/feeds/favorites/me | userId
HTTP method: GET
/chatter/feeds/favorites/me | userId
HTTP method: POST
/chatter/feeds/favorites/me |
userId/favoriteId
HTTP method: DELETE
Apex Methods
Chatter.getFollowers( String communityId,
String recordId )
Chatter.getFollowers( String communityId,
String recordId, Integer pageParam, Integer
pageSize )
Chatter.deleteSubscription(String communityId,
String subscriptionId )
Chatter.getSubscription( String communityId,
String subscriptionId )
ChatterFavorites.getFavorites( String
communityId, String subjectId )
ChatterFavorites.addFavorite( String
communityId, String subjectId, String
searchText )
ChatterFavorites.deleteFavorite(String
communityId, String subjectId, String
favoriteId )
272

Getting Started with Connect in Apex
Map Relating Chatter API Resources to Apex Methods
Chatter API Resources
/chatter/feeds/favorites/me |
userId/favoriteId
HTTP method: GET
/chatter/feeds/favorites/me |
userId/favoriteId
HTTP method: PATCH
/chatter/feeds/favorites/me |
userId/favoriteId/feed-items
HTTP method: GET
/chatter/comments/commentId/
HTTP method: DELETE
/chatter/comments/commentId
HTTP method: GET
/chatter/comments/commentId/likes
HTTP method: GET
/chatter/comments/commentId/likes
HTTP method: POST
Apex Methods
ChatterFavorites.getFavorite( String
communityId, String subjectId, String
favoriteId )
ChatterFavorites.updateFavorite( String
communityId, String subjectId, String
favoriteId, Boolean updateLastViewDate )
ChatterFavorites.getFeedItems( String
communityId, String subjectId, String
favoriteId )
ChatterFavorites.getFeedItems( String
communityId, String subjectId, String
favoriteId, String pageParam, Integer
pageSize, FeedSortOrder sortParam )
ChatterFeeds.deleteComment(String communityId,
String commentId )
ChatterFeeds.getComment( String communityId,
String commentId)
ChatterFeeds.getLikesForComment( String
communityId, String commentId )
ChatterFeeds.getLikesForComment( String
communityId, String commentId, Integer
pageParam, Integer pageSize )
ChatterFeeds.likeComment( String communityId,
String commentId )
/chatter/feeds/feedType
HTTP method: GET
Where feedType can be any type of feed, such as Bookmarks,
News, Records, and so on.
/chatter/feeds/feedType/me | userid/
HTTP method: GET
Where feedType can be any type of feed, such as Bookmarks,
News, Records, and so on.
ChatterFeeds.getFeed( String communityId,
ConnectApi.FeedType feedType )
ChatterFeeds.getFeed( String communityId,
ConnectApi.FeedType feedType
ConnectApi.SortOrder sortParam)
ChatterFeeds.getFeed( String communityId,
ConnectApi.FeedType feedType, String subjectId
)
ChatterFeeds.getFeed( String communityId,
ConnectApi.FeedType feedType, String
subjectId, ConnectApi.SortOrder sortParam)
273

Getting Started with Connect in Apex
Map Relating Chatter API Resources to Apex Methods
Chatter API Resources
Apex Methods
/chatter/feeds/feedType/feed-items
HTTP method: GET
Where feedType can be any type of feed, such as Bookmarks,
News, Records, and so on.
/chatter/feeds/feedType/feed-items
HTTP method: GET
Where feedType can be any type of feed, such as Bookmarks,
News, Records, and so on.
/chatter/feeds/feedType/feed-items/subjectId
HTTP method: GET
Where feedType can be any type of feed, such as Bookmarks,
News, Records, and so on.
ChatterFeeds.getFeedItemsFromFeed( String
communityId, ConnectApi.FeedType feedType )
ChatterFeeds.getFeedItemsFromFeed( String
communityId, ConnectApi.FeedType feedType,
String pageParam, Integer pageSize,
ConnectApi.FeedSortOrder sortParam )
ChatterFeeds.searchFeedItemsInFeed( String
communityId, ConnectApi.FeedType feedType,
String q)
ChatterFeeds.searchFeedItemsInFeed( String
communityId, ConnectApi.FeedType feedType,
String subjectId, String q)
ChatterFeeds.searchFeedItemsInFeed( String
communityId, ConnectApi.FeedType feedType,
String pageParam, Integer pageSize,
ConnectApi.FeedSortOrder sortParam, String q)
ChatterFeeds.searchFeedItemsInFeed( String
communityId, ConnectApi.FeedType feedType,
String subjectId, String pageParam, Integer
pageSize, ConnectApi.FeedSortOrder sortParam,
String q)
ChatterFeeds.getFeedItemsFromFeed( String
communityId, ConnectApi.FeedType feedType,
String subjectId )
ChatterFeeds.getFeedItemsFromFeed( String
communityId, ConnectApi.FeedType feedType,
String subjectId, String pageParam, Integer
pageSize, ConnectApi.FeedSortOrder sortParam
)
/chatter/feeds/filter/subjectId/keyPrefix
HTTP method GET
ChatterFeeds.getFilterFeed ( String
communityId, IDsubjectId, string keyPrefix)
ChatterFeeds.getFilterFeed ( String
communityId, IDsubjectId, string keyPrefix,
ConnectApi.FeedSortOrder sortParam )
/chatter/feeds/filter/subjectId/keyPrefix/feed-items
HTTP method GET
ChatterFeeds.getFeedItemsFromFilterFeed (
String communityId, IDsubjectId, string
keyPrefix)
ChatterFeeds.getFeedItemsFromFilterFeed (
String communityId, IDsubjectId, string
keyPrefix, String pageParam, Integer pageSize,
ConnectApi.FeedSortOrder sortParam )
274

Getting Started with Connect in Apex
Map Relating Chatter API Resources to Apex Methods
Chatter API Resources
/chatter/feed-items/feedItemId/poll
HTTP method GET and PATCH
Apex Methods
ChatterFeeds.getFeedPoll( String communityId,
IDfeedItemId )
ChatterFeeds.voteOnFeedPoll( String
communityId, IDfeedItemId, String myChoiceId)
/chatter/feeds/feedType/me | userid/feed-items
HTTP method: POST
Where feedType can be any type of feed, such as Bookmarks,
News, Records, and so on.
ChatterFeeds.shareFeedItem( String
communityId, ConnectApi.FeedType feedType,
String subjectId, String originalFeedItemId )
ChatterFeeds.postFeedItem( String communityId,
ConnectApi.FeedType feedType, String
subjectId, String text)
ChatterFeeds.postFeedItem( String communityId,
ConnectApi.FeedType feedType,String subjectId,
ConnectApi.FeedItemInput feedItem,
ConnectApi.BinaryInput feedItemFileUpload )
/chatter/feed-items
HTTP method: GET
/chatter/feed-items/feedItemId
HTTP method: PATCH
/chatter/feed-items/feedItemId/comments
HTTP method: GET
/chatter/feed-items/feedItemId/comments
HTTP method: POST
/chatter/feed-items/feedItemId/likes
HTTP method: GET
/chatter/feed-items/feedItemId/likes
HTTP method: POST
ChatterFeeds.searchFeedItems( String
communityId, String q )
ChatterFeeds.searchFeedItems( String
communityId, String q, String pageParam,
Integer pageSize )
ChatterFeeds.updateBookmark( String
communityId, String feedItemId, Boolean
isBookmarkedByCurrentUser )
ChatterFeeds.getCommentsForFeedItem( String
communityId, String feedItemId )
ChatterFeeds.getCommentsForFeedItem( String
communityId, String feedItemId, String
pageParam, Integer pageSize )
ChatterFeeds.postComment( String communityId,
String feedItemId, String text )
ChatterFeeds.postComment( String communityId,
String feedItemId, ConnectApi.CommentInput
comment, ConnectApi.BinaryInput
feedItemFileUpload )
ChatterFeeds.getLikesForFeedItem( String
communityId, String feedItemId )
ChatterFeeds.getLikesForFeedItem( String
communityId, String feedItemId, Integer
pageParam, Integer pageSize )
ChatterFeeds.likeFeedItem( String communityId,
String feedItemId )
275

Getting Started with Connect in Apex
Map Relating Chatter API Resources to Apex Methods
Chatter API Resources
/chatter/feed-items/feedItemId
HTTP method: DELETE
/chatter/feeds/news/me | userId/is-modified
HTTP method: GET
/chatter/likes/likeId
HTTP method: DELETE
/chatter/likes/likeId
HTTP method: GET
/chatter/group-membership-requests/requestId
HTTP method: GET
/chatter/groups/groupId/members/requests
HTTP method: GET
/chatter/groups/groupId/members/requests
HTTP method: PATCH
/chatter/groups/groupId/my-settings
HTTP method: GET
/chatter/groups/groupId/my-settings
HTTP method: PATCH
/chatter/groups
HTTP method: GET
Apex Methods
ChatterFeeds.deleteFeedItem( String
communityId, String feedItemId )
ChatterFeeds.isModified( String communityId,
Enum FeedType feedType, String subjectId,
String since)
ChatterFeeds.deleteLike (String communityId,
String likeId )
ChatterFeeds.getLike (String communityId,
String likeId)
ChatterGroups.getMembershipRequest (String
communityId, String groupId)
ChatterGroups.getMembershipRequests (String
communityId, String groupId)
ChatterGroups.getMembershipRequests (String
communityId, String groupId,
ConnectApi.GroupMembershipRequestStatus
status)
ChatterGroups.requestMembershipRequest
(String communityId, String groupId)
ChatterGroups.getMyChatterSettings (String
communityId, String groupId)
ChatterGroups.updateMyChatterSettings (String
communityId, String groupId,
ConnectApi.GroupEmailFrequency emailFrequency)
ChatterGroups.getGroups( String communityId)
ChatterGroups.getGroups( String communityId,
Integer pageParam, Integer pageSize )
ChatterGroups.searchGroups( String
communityId, String q )
ChatterGroups.searchGroups( String
communityId, String q, Integer pageParam,
Integer pageSize )
/chatter/groups/groupId
HTTP method: GET
ChatterGroups.getGroup( String communityId,
String groupId )
276

Getting Started with Connect in Apex
Map Relating Chatter API Resources to Apex Methods
Chatter API Resources
/chatter/groups/groupId/members
HTTP method: GET
/chatter/groups/groupId/members
HTTP method: POST
/chatter/groups/groupId/photo
HTTP method: DELETE
/chatter/groups/groupId/photo
HTTP method: GET
/chatter/groups/groupId/photo
HTTP method: POST
Apex Methods
ChatterGroups.getMembers( String communityId,
String groupId )
ChatterGroups.getMembers( String communityId,
String groupId, Integer pageParam, Integer
pageSize )
ChatterGroups.addMember( String communityId,
String groupId, String userId )
ChatterGroups.deletePhoto( String communityId,
String groupId )
ChatterGroups.getPhoto(String communityId,
String groupId )
ChatterGroups.setPhoto( String communityId,
String groupId, String fileId, Integer
versionNumber )
ChatterGroups.setPhoto( String communityId,
String groupId, ConnectApi.BinaryInput
fileUpload )
/chatter/group-memberships/membershipId
HTTP method: DELETE
/chatter/group-memberships/membershipId
HTTP method: GET
/chatter/users
HTTP method: GET
ChatterGroups.deleteMember(String communityId,
String membershipId )
ChatterGroups.getMember( String communityId,
String membershipId )
ChatterUsers.getUsers( String communityId)
ChatterUsers.getUsers( String communityId,
Integer pageParam, Integer pageSize )
ChatterUsers.searchUsers( String communityId,
String q )
ChatterUsers.searchUsers( String communityId,
String q, Integer pageParam, Integer pageSize
)
/chatter/users/me | userId
HTTP method: GET
/chatter/users/me | userId/followers
HTTP method: GET
ChatterUsers.getUser(String communityId,
String userId )
ChatterUsers.getFollowers(String communityId,
String userId )
ChatterUsers.getFollowers( String communityId,
String userId, Integer pageParam, Integer
pageSize )
277

Getting Started with Connect in Apex
Map Relating Chatter API Resources to Apex Methods
Chatter API Resources
/chatter/users/me | userId/following
HTTP method: GET
Apex Methods
ChatterUsers.getFollowings( String
communityId, String userId )
ChatterUsers.getFollowings( String
communityId, String userId Integer pageParam)
ChatterUsers.getFollowings( String
communityId, String userId, Integer pageParam,
Integer pageSize)
ChatterUsers.getFollowings( String
communityId, String userId, String filterType
)
ChatterUsers.getFollowings( String
communityId, String userId, String filterType,
Integer pageParam)
ChatterUsers.getFollowings( String
communityId, String userId, String filterType,
Integer pageParam, Integer pageSize)
/chatter/users/me | userId/following
HTTP method: POST
/chatter/users/me | userId/groups
HTTP method: GET
/chatter/users/me | userId/photo
HTTP method: DELETE
/chatter/users/me | userId/photo
HTTP method: GET
/chatter/users/me | userId/photo
HTTP method: POST
ChatterUsers.follow( String communityId,
String userId, String subjectId )
ChatterUsers.getGroups( String communityId,
String userId )
ChatterUsers.getGroups( String communityId,
String userId, Integer pageParam, Integer
pageSize )
ChatterUsers.deletePhoto(String communityId,
String userId )
ChatterUsers.getPhoto( String communityId,
String userId )
ChatterUsers.setPhoto( String communityId,
String userId, String fileId, Integer
versionNumber )
ChatterUsers.setPhoto( String communityId,
String userId, ConnectApi.BinaryInput
fileUpload )
/chatter/users/me | userId/settings
HTTP method: GET
/chatter/users/me | userId/settings
HTTP method: PATCH
ChatterUsers.getChatterSettings( String
communityId, String userId)
ChatterUsers.updateChatterSettings( String
communityId, String userId,
ConnectApi.GroupEmailFrequency
defaultGroupEmailFrequency )
278

Getting Started with Connect in Apex
Map Relating Chatter API Resources to Apex Methods
Chatter API Resources
/connect/motifs/idOrPrefix
HTTP method: GET
Apex Methods
Records.getMotif( String communityId, String
idOrPrefix)
See Also:
Getting Started with Connect in Apex
279

Chapter 8
Connect in Apex API Reference
In this chapter ...
In Chatter REST API, you send requests to resources, and get a response in
return. In Connect in Apex, the operations exposed by Chatter REST API
• Chatter Class resources are made available through static methods in classes. Input and output
• ChatterFavorites Class data is provided in objects. All Connect in Apex classes are found in the
• ChatterFeeds Class
ConnectApi namespace.
• ChatterGroups Class
• ChatterUsers Class
• Records Class
• Input Classes
• Output Classes
• Enums
• Exceptions
280

Connect in Apex API Reference
Chatter Class
Chatter Class
Use this class to access information about followers and subscriptions for records.
Static Methods
Note: Communities are available as a pilot program.
Name
Parameters
Returns
Description
deleteSubscription
String communityId,
String subscriptionId
void
Deletes the specified subscription. Use
this to unfollow something, such as a
record, a user, or a file. Use the
ChatterGroups Class to leave a group.
Use null for communityId.
getSubscription
String communityId,
String subscriptionId
Subscription
Returns information about the
specified subscription. Use null for
communityId.
getFollowers
String communityId,
String recordId
FollowerPage
Returns the first page of followers for
the specified record in the specified
community. The page contains the
default number of items. Use either a
record Id or the keyword me.
getFollowers
String communityId,
String recordId,
Integer pageParam,
Integer pageSize
FollowerPage
Returns the specified page of followers
for the specified record.
• communityId—Use null for
communityId.
• recordId—Specify the record you
want information about, or use the
keyword me.
• pageParam—Specifies the number
of the page you want returned.
Starts at 0. If you pass in null or
0, the first page is returned.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 1000. If you pass
null, the default size is 25.
See Also:
Connect in Apex API Reference
281

Connect in Apex API Reference
ChatterFavorites Class
ChatterFavorites Class
Use this class to add, get, update, and delete Chatter favorites. Chatter favorites give you easy access to list views, feed searches,
and topics.
Static Methods
Note: Communities are available as a pilot program.
Name
Parameters
Returns
Description
addFavorite
String communityId,
String subjectId,
String searchText
FeedFavorite
Adds a favorite for the specified
user in the specified community.
• communityId—Use null for
communityId.
• subjectId—Specify a user
ID. subjectId must be the
same as the context user. You
can use the string me to specify
the context user instead of an
Id.
• searchText—Specify the text
of the search to be saved as a
favorite. This method can only
create a saved search favorite,
not a list view favorite.
deleteFavorite
String communityId,
String subjectId,
String favoriteId
void
Deletes the specified favorite.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id. Use null
for communityId.
getFavorite
String communityId,
String subjectId,
String favoriteId
FeedFavorite
Returns a description of the
favorite.
• communityId—Use null for
communityId.
• subjectId—Specify a user
ID. subjectId must be the
same as the context user. You
can use the string me to specify
the context user instead of an
Id.
• favoriteId—Specify the
favorite ID.
282

Connect in Apex API Reference
ChatterFavorites Class
Name
getFavorites
getFeedItems
getFeedItems
Parameters
String communityId,
String subjectId,
String communityId,
String subjectId,
String favoriteId
Returns
FeedFavorites
FeedItemPage
Description
Returns a list of all favorites for
the specified user in the specified
community. subjectId must be
the same as the context user. You
can use the string me to specify the
context user instead of an Id.
Returns the first page of feed items
for the specific favorite in the
specified community. The page
contains the default number of
items.subjectId must be the
same as the context user. You can
use the string me to specify the
context user instead of an Id.
String communityId,
String subjectId,
FeedItemPage
Returns the specified page of feed
items for the specified favorite, in
the specified community in the
String favoriteId,
specified order.
String pageParam,
• communityId—Use null for
communityId.
Integer pageSize, • subjectId—Specify a user
FeedSortOrder
ID. subjectId must be the
enumsortParam
same as the context user. You
can use the string me to specify
the context user instead of an
Id.
• favoriteId—Specify the
favorite ID.
• pageParam—Specifies the
page token to be used 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.
• pageSize—Specifies the
number of items per page.
Valid values are between 1 and
100. If you pass in null, the
default size is 25.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either
by created date in ascending
283

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
order, or by last modified date,
also in ascending order. If you
pass in null, the default
CreatedDateDesc is used.
updateFavorite
String communityId,
String subjectId,
String favoriteId,
Boolean
updateLastViewDate
FeedFavorite
If you specify true for
updateLastViewDate, this
method updates the last view date
of the specified favorite to the
current system time. Use null for
communityId.subjectId must
be the same as the context user.
You can use the string me to
specify the context user instead of
an Id.
See Also:
Connect in Apex API Reference
ChatterFeeds Class
Use this class to access and modify feeds and feed data. This includes accessing, adding, and deleting feed items, as well as
likes, comments, and bookmarks. You can also use this class to search feed items.
The composition of a feed may change between releases. Your code should always be prepared to handle unknown subclasses
in both MessageSegment and FeedItemAttachment objects.
Static Methods
Note: Communities are available as a pilot program.
Name
Parameters
Returns
Description
deleteComment
String communityId,
String commentId
void
Deletes the specified comment. Use
null for communityId.
deleteFeedItem
String communityId,
String feedItemId
void
Deletes the specified feed item. Use
null for communityId.
deleteLike
String communityId,
String likeId
void
Deletes the specified like. This can
be a like on either a comment or a
feed item. Use null for
communityId.
284

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
getComment
String communityId,
String commentId
Comment
Returns the specified comment. Use
null for communityId.
getCommentsForFeedItem
String communityId,
String feedItemId
CommentPage
Returns the first page of comments
for the specified feed item. The page
contains the default number of items.
Use null for communityId.
getCommentsForFeedItem
String communityId,
String feedItemId,
String pageParam,
Integer pageSize
CommentPage
Returns the specified page of
comments for the specified feed item.
• communityId—Use null for
communityId.
• feedItemId—Specify the Id of
a feed item.
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
getFeed
getFeed
String communityId,
FeedType enum feedType
Feed
Returns information about the feed
for the specified feed type. Use null
for communityId. The only valid
value for feedType for this method
is Company.
String communityId,
FeedType enum feedType,
Feed
Returns the feed for the specified feed
type in the specified order.
• communityId—Use null for
FeedSortOrder enum
communityId.
sortParam • feedType—The only valid value
for feedType for this method is
Company.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
285

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
getFeed
String communityId,
FeedType enum feedType,
String subjectId
Feed
Returns the feed for the specified feed
type for the specified user.
• communityId—Use null for
communityId.
• Valid values for feedType are:
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Files
Groups
News
People
Record
To
UserProfile
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
getFeed
String communityId,
FeedType enum feedType,
Feed
Returns the feed for the specified feed
type for the specified user, in the
specified order.
String subjectId,
• communityId—Use null for
communityId.
FeedSortOrder enum
sortParam • feedType—
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Files
Groups
News
People
Record
To
UserProfile
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
286

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
getFeedItem
String communityId,
String feedItemId
FeedItem
Returns a rich description of the
specified feed item. Use null for
communityId.
getFeedItemsFromFeed
String communityId,
FeedType enum feedType
FeedItemPage
Returns the first page of feed items
for the specified feed type. When
invoked during a test with the
matching
setTestGetFeedItemsFromFeed
method, returns the feed item page
passed in with that method. You
must use the test method with the
exact same parameters, or you receive
an assert.The page contains the
default number of items. The only
valid value for feedType for this
method is Company. Use null for
communityId.
getFeedItemsFromFeed
String communityId,
FeedType enum feedType,
String pageParam,
Integer pageSize,
FeedSortOrder enum
sortParam
FeedItemPage
Returns the feed items for the
specified page for the specified feed
type, in the specified order. When
invoked during a test with the
matching
setTestGetFeedItemsFromFeed
method, returns the feed item page
passed in with that method. You
must use the test method with the
exact same parameters, or you receive
an assert.
• communityId—Use null for
communityId.
• feedType—The only valid value
for feedType for this method is
Company.
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
• sortParam—Values are:
287

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
getFeedItemsFromFeed
String communityId,
FeedType enum feedType,
String subjectId
FeedItemPage
Returns the first page of feed items
for the specified feed type, for the
specified user. When invoked during
a test with the matching
setTestGetFeedItemsFromFeed
method, returns the feed item page
passed in with that method. You
must use the test method with the
exact same parameters, or you receive
an assert.The page contains the
default number of items.
• communityId—Use null for
communityId.
• Valid values for feedType are:
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Files
Groups
News
People
Record
To
UserProfile
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
getFeedItemsFromFeed
String communityId,
FeedType enum feedType,
String subjectId,
String pageParam,
Integer pageSize,
FeedSortOrder enum
sortParam
FeedItemPage
Returns the feed items on the
specified page for the specified user,
for the specified feed type in the
specified order. When invoked during
a test with the matching
setTestGetFeedItemsFromFeed
method, returns the feed item page
passed in with that method. You
must use the test method with the
288

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
exact same parameters, or you receive
an assert.
• communityId—Use null for
communityId.
• feedType—
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Files
Groups
News
People
Record
To
UserProfile
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
getFeedItemsFromFilterFeed
String communityId,
String subjectId
String keyPrefix
FeedItemPage
Returns the first page of feed items
for the specified user and the
specified key prefix. When invoked
during a test with the matching
setTestGetFeedItemsFromFilterFeed
method, returns the feed item page
that was passed in with that method,
289

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
filtered by the key prefix: only the
feed items associated with the
specified type are returned. You must
use the test method with the exact
same parameters, or you receive an
exception. The page contains the
default number of items.
• communityId—Use null for
communityId.
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• keyPrefix—Specify the key
prefix of the type of record you
want. A 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.
getFeedItemsFromFilterFeed
String communityId,
String subjectId
String keyPrefix
String pageParam,
Integer pageSize,
FeedSortOrder enum
sortParam
FeedItemPage
Returns the specified page of feed
items for the specified user and the
specified key prefix, in the specified
order. When invoked during a test
with the matching
setTestGetFeedItemsFromFilterFeed
method, returns the feed item page
that was passed in with that method,
filtered by the key prefix: only the
feed items associated with the
specified type are returned. You must
use the test method with the exact
same parameters, or you receive an
exception.
• communityId—Use null for
communityId.
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• keyPrefix—Specify the key
prefix of the type of record you
want. A key prefix is the
three-character prefix code in the
290

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
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.
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
getFeedPoll
String communityId,
String feedItemId
FeedPoll
Returns the poll associated with the
specified feed item. Use null for
communityId.
getFilterFeed
String communityId,
String subjectId
String keyPrefix
Feed
Returns the first page of a feed for
the specified user and the given key
prefix.
• communityId—Use null for
communityId.
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• keyPrefix—Specify the key
prefix of the type of record you
want. A 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
291

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
prefix of 005 and Group objects
have a prefix of 0F9.
getFilterFeed
String communityId, Feed
Returns the first page of a feed in the
specified order for the specified user
String subjectId
and the given key prefix.
String keyPrefix
• communityId—Use null for
communityId.
FeedSortOrder enum
sortParam • subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• keyPrefix—Specify the key
prefix of the type of record you
want. A 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.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
getLike
String communityId,
String likeId
ChatterLike
Returns the specified like. Use null
for communityId.
getLikesForComment
String communityId,
String commentId
ChatterLikePage
Returns the first page of likes for the
specified comment. Use null for
communityId. The page contains
the default number of items.
getLikesForComment
String communityId,
String commentId,
Integer pageParam,
Integer pageSize
ChatterLikePage
Returns the specified page of likes for
the specified comment.
• communityId—Use null for
communityId.
• commentId—Specify the
comment Id.
292

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
• pageParam—Specifies the
number of the page you want
returned. Starts at 0. If you pass
in null or 0, the first page is
returned.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
getLikesForFeedItem
String communityId,
String feedItemId
ChatterLikePage
Returns the first page of likes for the
specified feed item. Use null for
communityId. The page contains
the default number of items.
getLikesForFeedItem
String communityId,
String feedItemId,
Integer pageParam,
Integer pageSize
ChatterLikePage
Returns the specified page of likes for
the specified feed item.
• communityId—Use null for
communityId.
• feedItemId—Specify the Id for
the feed item
• pageParam—Specifies the
number of the page you want
returned. Starts at 0. If you pass
in null or 0, the first page is
returned.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
isModified
String communityId,
FeedType Enum feedType,
String subjectId,
String since
FeedModifiedInfo
Class
Returns information about whether
a feed has been updated or changed.
Use this method to poll a feed for
updates.
• communityId—Use null for
communityId.
• feedType—Specifies the type of
feed. The only supported type is
News
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• since—an opaque token
containing information about the
last modified date of the feed.
Retrieve this token from
293

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
Feed.isModifiedToken or
FeedItemPage.isModifiedToken.
likeComment
String communityId,
String commentId
ChatterLike
Adds a like to the specified comment
for the context user. If the user has
already liked this comment, this is a
non-operation and returns the
existing like. Use null for
communityId.
likeFeedItem
String communityId,
String feedItemId
ChatterLike
Adds a like to the specified feed item
for the context user. If the user has
already liked this feed item, this is a
non-operation and returns the
existing like. Use null for
communityId.
postComment
String communityId,
String feedItemId,
String text
Comment
Adds the specified text as a comment
to the specified feed item, for the
context user. Use null for
communityId. If hashtags or links
are detected in text, they are
included in the comment as hashtag
and link segments. Mentions are not
detected in text and are not
separated out of the text.
postComment
String communityId,
String feedItemId,
CommentInput comment,
BinaryInput
feedItemFileUpload
Comment
Adds a comment to the specified feed
item from the context user. Use null
for communityId. Use
CommentInput to include richly
formatted comment text, such as
@mentions. If
feedItemFileUpload is non-null,
it specifies a file attachment for the
comment.
In CommentInput, you can only use
either ContentAttachmentInput
or NewFileAttachmentInput.
Use ContentAttachmentInput
to specify existing content as the
attachment so you can’t also supply a
file in feedItemFileUpload. If you
use NewFileAttachmentInput,
you must supply the binary file in
feedItemFileUpload.
postFeedItem
String communityId,
FeedType Enum feedType,
String subjectId,
FeedItem
Adds a feed item to the specified feed
from the context user.
• communityId—Use null for
communityId.
294

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
String text • feedType—One of the
following:
◊
◊
◊
News
Record
UserProfile
Use Record to post to a group.
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• text—the text of the comment.
Mentions and hashtags are
removed.
postFeedItem
String communityId,
FeedType enum feedType,
String subjectId,
FeedItemInput feedItem,
BinaryInput
feedItemFileUpload
FeedItem
Adds a feed item to the specified feed
from the context user. Use null for
communityId. Use
FeedItemInput to include richly
formatted text, such as @mentions.
If feedItemFileUpload is
non-null, it specifies a file attachment
for the feed item.
In FeedItemInput, if you
useContentAttachmentInput to
specify existing content as the
attachment, you can’t also supply a
file in feedItemFileUpload. If you
use NewFileAttachmentInput,
you must supply the binary file in
feedItemFileUpload.
shareFeedItem
String communityId,
FeedType Enum feedType,
String subjectId,
FeedItem
Share the originalFeedItemId to
the feed specified by the feedType,
subjectId and communityId. Use
null for communityId.
String
originalFeedItemId
searchFeedItems
String communityId,
String q
FeedItemPage
Returns the first page of all the
feed-items that match the specified
search criteria. The page contains the
default number of items.
• communityId—Use null for
communityId.
• q—Required and cannot be
null. Specifies the string to
search. The search string must
295

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
contain at least two characters,
not including any wildcards. For
more information about
wildcards, see Using Wildcards.
searchFeedItems
String communityId,
String q,
String pageParam,
Integer pageSize
FeedItemPage
Returns a list of all the feed-items
viewable by the context user that
match the specified search criteria.
• communityId—Use null for
communityId.
• q—Required and cannot be
null. Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards. For
more information about
wildcards, see Using Wildcards.
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
searchFeedItemsInFeed
String communityId,
FeedType enum feedType,
String q
FeedItemPage Class
Searches the feed items for a specified
feed type.
• communityId—Use null for
communityId.
• feedType—Specifies the type of
feed, such as a feed made up of
bookmarks, groups, or records:
◊
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Company
Files
Groups
News
People
Record
To
UserProfile
• q—Required and cannot be
null. Specifies the string to
296

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
search. The search string must
contain at least two characters,
not including any wildcards. For
more information about
wildcards, see Using Wildcards.
searchFeedItemsInFeed
String communityId,
FeedType enum feedType,
String subjectId,
String q
FeedItemPage Class
Searches the feed items for a specified
feed type and context user.
• communityId—Use null for
communityId.
• feedType—Specifies the type of
feed, such as a feed made up of
bookmarks, groups, or records:
◊
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Company
Files
Groups
News
People
Record
To
UserProfile
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• q—Required and cannot be
null. Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards. For
more information about
wildcards, see Using Wildcards.
searchFeedItemsInFeed
String communityId,
FeedType enum feedType,
String pageParam,
Integer pageSize,
FeedSortOrder enum
sortParam,
FeedItemPage Class
Searches the feed items for a specified
feed type and returns a specified page
and page size in a specified sort order.
• communityId—Use null for
communityId.
• feedType—Specifies the type of
feed, such as a feed made up of
bookmarks, groups, or records:
String q ◊ Bookmarks
◊ Company
◊ Files
297

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
◊
◊
◊
◊
◊
◊
Groups
News
People
Record
To
UserProfile
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
• q—Required and cannot be
null. Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards. For
more information about
wildcards, see Using Wildcards.
searchFeedItemsInFeed
String communityId,
FeedType enum feedType,
FeedItemPage Class Searches the feed items for a specified
feed type and context user, and
returns a specified page and page size
String subjectId,
in a specified sort order.
String pageParam,
• communityId—Use null for
communityId.
Integer pageSize, • feedType—Specifies the type of
FeedSortOrder enum
feed, such as a feed made up of
sortParam,
bookmarks, groups, or records:
String q ◊ Bookmarks
◊ Company
◊ Files
298

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
◊
◊
◊
◊
◊
◊
Groups
News
People
Record
To
UserProfile
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
• q—Required and cannot be
null. Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards. For
more information about
wildcards, see Using Wildcards.
setTestGetFeedItemsFromFeed
String communityId,
FeedType enum feedType
FeedItemPage result
void
Registers a test feed item page to be
returned when
getFeedItemsFromFeed is called
with matching parameters during a
test. You must use the get feed
method with the exact same
parameters, or you receive an assert.
299

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
• communityId—Use null for
communityId.
• feedType—The only valid value
for feedType for this method is
Company.
• result—Specify the test feed
item page.
setTestGetFeedItemsFromFeed String communityId,
FeedType enum feedType,
void
Registers a test feed item page to be
returned when
getFeedItemsFromFeed is called
String pageParam,
with matching parameters during a
Integer pageSize,
test. You must use the get feed
method with the exact same
FeedSortOrder enum
parameters, or you receive an assert.
sortParam • communityId—Use null for
FeedItemPage result
communityId.
• feedType—The only valid value
for feedType for this method is
Company.
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
• result—Specify the test feed
item page.
setTestGetFeedItemsFromFeed
String communityId,
FeedType enum feedType,
String subjectId,
void
Registers a test feed item page to be
returned when
getFeedItemsFromFeed is called
with matching parameters during a
test. You must use the get feed
300

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
FeedItemPage result
method with the exact same
parameters, or you receive an assert.
• communityId—Use null for
communityId.
• feedType—
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Files
Groups
News
People
Record
To
UserProfile
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• result—Specify the test feed
item page.
setTestGetFeedItemsFromFeed
String communityId,
FeedType enum feedType,
String subjectId
String pageParam,
Integer pageSize,
FeedSortOrder enum
sortParam
FeedItemPage result
void
Registers a test feed item page to be
returned when
getFeedItemsFromFeed is called
with matching parameters during a
test. You must use the get feed
method with the exact same
parameters, or you receive an assert.
• communityId—Use null for
communityId.
• feedType—
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Files
Groups
News
People
Record
To
UserProfile
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
301

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
• result—Specify the test feed
item page.
setTestGetFeedItemsFromFilterFeed
String communityId,
String subjectId
String keyPrefix
FeedItemPage result
void
Creates a feed item page used for
testing. After you create the page, use
the matching
getFeedItemsFromFilterFeed
method to access the test page and
run your tests. You must use the get
feed filter method with the exact
same parameters, or you receive an
assert.
• communityId—Use null for
communityId.
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• keyPrefix—Specify the key
prefix of the type of record you
want. A 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
302

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
prefix of 005 and Group objects
have a prefix of 0F9.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
• result—Specify the test feed
item page.
setTestGetFeedItemsFromFilterFeed String communityId,
String subjectId
String keyPrefix
String pageParam,
Integer pageSize,
FeedSortOrder enum
sortParam
FeedItemPage result
void
Creates a feed item page used for
testing. After you create the page, use
the matching
getFeedItemsFromFilterFeed
method to access the test page and
run your tests. You must use the get
feed filter method with the exact
same parameters, or you receive an
assert.
• communityId—Use null for
communityId.
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• keyPrefix—Specify the key
prefix of the type of record you
want. A 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.
• pageParam—Specifies the page
token to be used 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.
303

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
• result—Specify the test feed
item page.
setTestSearchFeedItemsInFeed
String communityId,
FeedType enum feedType,
String q,
FeedItemPage Class result
void
Creates a feed item page to use for
testing. After you create the page, use
the matching
searchFeedItemsInFeed method
to access the test page and run your
tests. You must use the method with
the same parameters or you receive
an assert.
• communityId—Use null for
communityId.
• feedType—Specifies the type of
feed, such as a feed made up of
bookmarks, groups, or records:
◊
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Company
Files
Groups
News
People
Record
To
UserProfile
• q—Required and cannot be
null. Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards. For
more information about
wildcards, see Using Wildcards.
304

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
• result—Specify the test feed
item page.
setTestSearchFeedItemsInFeed
String communityId,
FeedType enum feedType,
String subjectId,
String q,
FeedItemPage Class result
void
Creates a feed item page to use for
testing. After you create the page, use
the matching
searchFeedItemsInFeed method
to access the test page and run your
tests. You must use the method with
the same parameters or you receive
an assert.Searches the feed items in
a specified feed type for the context
user.
• communityId—Use null for
communityId.
• feedType—Specifies the type of
feed, such as a feed made up of
bookmarks, groups, or records:
◊
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Company
Files
Groups
News
People
Record
To
UserProfile
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• q—Required and cannot be
null. Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards. For
more information about
wildcards, see Using Wildcards.
• result—Specify the test feed
item page.
setTestSearchFeedItemsInFeed
String communityId,
FeedType enum feedType,
String pageParam,
Integer pageSize,
void
Creates a feed item page to use for
testing. After you create the page, use
the matching
searchFeedItemsInFeed method
to access the test page and run your
305

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
FeedSortOrder sortParam,
tests. You must use the method with
String q,
the same parameters or you receive
an assert.
FeedItemPage Class result • communityId—Use null for
communityId.
• feedType—Specifies the type of
feed, such as a feed made up of
bookmarks, groups, or records:
◊
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Company
Files
Groups
News
People
Record
To
UserProfile
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
null, the default
CreatedDateDesc is used.
• q—Required and cannot be
null. Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards. For
more information about
wildcards, see Using Wildcards.
• result—Specify the test feed
item page.
306

Connect in Apex API Reference
ChatterFeeds Class
Name
Parameters
Returns
Description
setTestSearchFeedItemsInFeed
String communityId,
FeedType enum feedType,
String subjectId,
String pageParam,
Integer pageSize,
FeedSortOrder sortParam,
String q,
FeedItemPage Class result
void
Creates a feed item page to use for
testing. After you create the page, use
the matching
searchFeedItemsInFeed method
to access the test page and run your
tests. You must use the method with
the same parameters or you receive
an assert.
• communityId—Use null for
communityId.
• feedType—Specifies the type of
feed, such as a feed made up of
bookmarks, groups, or records:
◊
◊
◊
◊
◊
◊
◊
◊
◊
Bookmarks
Company
Files
Groups
News
People
Record
To
UserProfile
• subjectId—Specify a user ID.
subjectId must be the same as
the context user. You can use the
string me to specify the context
user instead of an Id.
• pageParam—Specifies the page
token to be used 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.
• pageSize—Specifies the number
of items per page. Valid values are
between 1 and 100. If you pass in
null, the default size is 25.
• sortParam—Values are:
◊
◊
CreatedDateDesc
LastModifiedDateDesc
Sorts the returned feed either by
created date in ascending order,
or by last modified date, also in
ascending order. If you pass in
307

Connect in Apex API Reference
ChatterGroups Class
Name
Parameters
Returns
Description
null, the default
CreatedDateDesc is used.
• q—Required and cannot be
null. Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards. For
more information about
wildcards, see Using Wildcards.
• result—Specify the test feed
item page.
updateBookmark
voteOnFeedPoll
String communityId,
String feedItemId,
Boolean
isBookmarkedByCurrentUser
String communityId,
String feedItemId,
String myChoiceId
FeedItem
FeedPoll
Updates the specified feed item. Use
null for communityId. Specifying
true for
isBookmarkedByCurrentUser
adds the feed item to the list of
bookmarks for the current user.
Specify false to remove a
bookmark.
Used to vote or to change your vote
on an existing feed poll.
• communityId—Use null for
communityId.
• feedItemId—Specify the feed
item that is associated with the
poll
• myChoiceId—Specify the Id of
the item in the poll to vote for.
See Also:
Connect in Apex API Reference
ChatterGroups Class
Use this class to access information about groups, such as the group’s members, photo, and the groups the specified user is
following. Also use this class to add members to a group, remove members, and change the group photo.
Static Methods
Note: Communities are available as a pilot program.
308

Connect in Apex API Reference
ChatterGroups Class
Name
Parameters
Returns
Description
addMember
String communityId,
String groupId,
String userId
GroupMember
Adds the specified user to the
specified group in the specified
community. This method is only
successful when the context user
is allowed to manage the group.
• communityId—Use null
for communityId.
• groupId—The ID for a
group.
• userId—The ID for a user.
deleteMember
String communityId,
String membershipId
void
Deletes the specified membership.
• communityId—Use null
for communityId.
• membershipId—The ID for
a membership.
deletePhoto
String communityId,
String groupId
void
Deletes the photo of the specified
group.
• communityId—Use null
for communityId.
• groupId—The ID for a
group.
getGroup
String communityId,
String groupId
ChatterGroup
Returns information about the
specified group.
• communityId—Use null
for communityId.
• groupId—The ID for a
group.
getGroupMembershipRequest
getGroupMembershipRequests
String communityId,
String requestId
String communityId,
String groupId
GroupMembershipRequest
GroupMembershipRequests
Returns information about the
specified request to join a private
group.
• communityId—Use null
for communityId.
• requestId—The ID of a
request to join a private group.
Returns information about every
request to join the specified
private group.
• communityId—Use null
for communityId.
• groupId—The ID of a
group.
309

Connect in Apex API Reference
ChatterGroups Class
Name
getGroupMembershipRequests
Parameters
String communityId,
String groupId,
Enum
GroupMembershipRequestStatus
status
Returns
Description
GroupMembershipRequests Returns information about every
request to join the specified
private group that has a specified
status.
• communityId—Use null
for communityId.
• groupId—The ID of a
group.
• The status of a request to join
a private group.
◊
◊
◊
Accepted
Declined
Pending
getGroups
String communityId
ChatterGroupPage
Returns the first page of all the
groups. The page contains the
default number of items.
• communityId—Use null
for communityId.
getGroups
String communityId,
Integer pageParam,
Integer pageSize
ChatterGroupPage
Returns the specified page of
information about all groups.
• communityId—Use null
for communityId.
• pageParam——The number
of the page you want returned.
Starts at 0. If you pass null
or 0, the first page is returned.
• pageSize—The number of
items per page. Valid values
are between 1 and 100. If you
pass null, the default size is
25.
getMember
String communityId,
String membershipId
GroupMember
Returns information about the
specified group member.
• communityId—Use null
for communityId.
• membershipId—The ID for
a membership.
getMembers
String communityId,
String groupId
GroupMemberPage
Returns the first page of
information about all members of
the specified group. The page
contains the default number of
items.
310

Connect in Apex API Reference
ChatterGroups Class
Name
Parameters
Returns
Description
• communityId—Use null
for communityId.
• groupId—The ID for a
group.
getMembers
String communityId,
String groupId,
Integer pageParam,
Integer pageSize
GroupMemberPage
Returns the specified page of
information about all members of
the specified group.
• communityId—Use null
for communityId.
• groupId—The ID for a
group.
• pageParam——The number
of the page you want returned.
Starts at 0. If you pass null
or 0, the first page is returned.
• pageSize—The number of
items per page. Valid values
are between 1 and 100. If you
pass null, the default size is
25.
getMyChatterSettings
String communityId,
String groupId
GroupChatterSettings
Returns the context user’s Chatter
settings for the specified group.
• communityId—Use null
for communityId.
• groupId—The ID for a
group.
getPhoto
String communityId,
String groupId
Photo
Returns information about the
photo for the specified group.
• communityId—Use null
for communityId.
• groupId—The ID for a
group.
requestGroupMembership
String communityId,
String groupId
GroupMembershipRequest Requests membership in a private
group for the context user.
• communityId—Use null
for communityId.
• groupId—The ID of a
private group.
searchGroups
String communityId,
String q
ChatterGroupPage
Returns the first page of groups
that match the specified search
criteria. The page contains the
default number of items.
311

Connect in Apex API Reference
ChatterGroups Class
Name
Parameters
Returns
Description
• communityId—Use null
for communityId.
• q—Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards.
For more information about
wildcards, see Using
Wildcards. Can be specified
as null.
searchGroups
String communityId,
String q,
Integer pageParam,
Integer pageSize
ChatterGroupPage
Returns the specified page of
groups that match the specified
search criteria.
• communityId—Use null
for communityId.
• q—Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards.
For more information about
wildcards, see Using
Wildcards. Can be specified
as null.
• pageParam—Specifies the
number of the page you want
returned. Starts at 0. If you
pass in null or 0, the first
page is returned.
• pageSize—Specifies the
number of items per page.
Valid values are between 1 and
100. If you pass in null, the
default size is 25.
setPhoto
String communityId,
String groupId,
String fileId,
Integer versionNumber
Photo
Sets the group photo to be the
specified, already uploaded file.
• communityId—Use null
for communityId.
• groupId—The ID for a
group.
• fileId—ID of a file already
uploaded. The file must be an
image smaller than 2 MB.
• versionNumber—Version
number of the existing file.
Specify either an existing
version number or, to get the
latest version, specify null.
312

Connect in Apex API Reference
ChatterGroups Class
Name
setPhoto
Parameters
Returns
Description
String communityId,
String groupId,
Photo
Sets the provided blob to be the
photo for the specified group. .
• communityId—Use null
ABinaryInput Class
for communityId.
fileUpload • groupId—The ID for a
group.
• fileUpload—An image to
use as the group photo. The
content type must be usable
as an image.
updateMyChatterSettings
String communityId,
String groupId,
Enum emailFrequency
GroupChatterSettings
Updates the context user’s Chatter
settings for the specified group.
• communityId—Use null
for communityId.
• groupId—The ID for a
group.
• emailFrequency—Specifies
the frequency with which a
user receives email from a
group.
◊
◊
◊
◊
◊
EachPost
DailyDigest
WeeklyDigest
Never
UseDefault
The value UseDefault uses
the value set in a call to
ChatterUsers.updateChatterSettings.
updateRequestStatus
String communityId,
String requestId,
Enum status
GroupMembershipRequest Updates a request to join a private
group.
• communityId—Use null
for communityId.
• requestId—The ID for a
request to join a private group.
• status—The status of the
request:
◊
◊
Accepted
Declined
313

Connect in Apex API Reference
ChatterUsers Class
Name
Parameters
Returns
Description
The Pending value of the
enum is not valid in this
method.
See Also:
Connect in Apex API Reference
ChatterUsers Class
Use this class to access information about the user, such as who is following the user, the user’s subscriptions, files, and groups.
Static Methods
Note: Communities are available as a pilot program.
Name
Parameters
Returns
Description
deletePhoto
String communityId,
String userId
void
Deletes the specified user’s
photo. Use either the Id for a
user or the keyword me. Use
null for communityId.
follow
String communityId,
String userId,
String subjectId
Subscription
Adds the specified userId as
a follower to the specified
subjectId. Use either the Id
for a user or the keyword me.
Use null for communityId.
getChatterSettings
String communityId,
String userId
UserChatterSettings
Returns information about the
default Chatter settings for the
specified user.
Use null for communityId.
Use either the Id for a user or
the keyword me.
getFollowers
String communityId,
String userId
FollowerPage
Returns the first page of
followers for the specified user
Id. Use null for
communityId. The page
contains the default number
of items.
314

Connect in Apex API Reference
ChatterUsers Class
Name
Parameters
Returns
Description
getFollowers
String communityId,
String userId,
Integer pageParam,
Integer pageSize
FollowerPage
Returns the specified page of
followers for the specified user
Id.
• communityId—Use null
for communityId.
• userId—Specify the user
Id whose followers you
want to see. Use either the
Id for a user or the
keyword me.
• pageParam—Specifies the
number of the page you
want returned. Starts at 0.
If you pass in null or 0,
the first page is returned.
• pageSize—Specifies the
number of items per page.
Valid values are between 1
and 100. If you pass in
null, the default size is
25.
getFollowings
String communityId,
String userId
FollowingPage
Returns the first page of
information about the
followers of the specified user.
Use null for communityId.
Use either the Id for a user or
the keyword me. The page
contains the default number
of items. This is different than
getFollowers, which
returns the users that follow
the specified user.
getFollowings
String communityId,
String userId,
Integer pageParam
FollowingPage
Returns the specified page of
information about the
followers of the specified user.
The page contains the default
number of items. This is
different than
getFollowers, which
returns the users that follow
the specified user.
• communityId—Use null
for communityId.
• userId—Specify the user
Id whose followers you
want to see. Use either the
Id for a user or the
keyword me.
315

Connect in Apex API Reference
ChatterUsers Class
Name
Parameters
Returns
Description
• pageParam—Specifies the
number of the page you
want returned. Starts at 0.
If you pass in null or 0,
the first page is returned.
getFollowings
String communityId,
String userId,
Integer pageParam,
Integer pageSize
FollowingPage
Returns the specific page of
information about the
followers of the specified user.
This is different than
getFollowers, which
returns the users that follow
the specified user.
• communityId—Use null
for communityId.
• userId—Specify the user
Id whose followers you
want to see. Use either the
Id for a user or the
keyword me.
• pageParam—Specifies the
number of the page you
want returned. Starts at 0.
If you pass in null or 0,
the first page is returned.
• pageSize—Specifies the
number of items per page.
Valid values are between 1
and 1000. If you pass
null, the default size is
25.
getFollowings
String communityId,
String userId,
String filterType
FollowingPage
Returns the first page of
information about the
specified types of followers of
the specified user. The page
contains the default number
of items. This is different than
getFollowers, which
returns the users that follow
the specified user.
• communityId—Use null
for communityId.
• userId—Specify the user
Id whose followers you
want to see. Use either the
Id for a user or the
keyword me.
316

Connect in Apex API Reference
ChatterUsers Class
Name
Parameters
Returns
Description
• filterType—Specifies
the key prefix to filter the
type of objects returned.
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.
getFollowings
String communityId,
String userId,
String filterType,
Integer pageParam
FollowingPage
Returns the specified page of
information about the
specified types of followers of
the specified user. The page
contains the default number
of items. This is different than
getFollowers, which
returns the users that follow
the specified user.
• communityId—Use null
for communityId.
• userId—Specify the user
Id whose followers you
want to see
• userId—Specify the user
Id whose followers you
want to see
• filterType—Specifies
the key prefix to filter the
type of objects returned.
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.
• pageParam—Specifies the
number of the page you
want returned. Starts at 0.
If you pass in null or 0,
the first page is returned.
317

Connect in Apex API Reference
ChatterUsers Class
Name
Parameters
Returns
Description
getFollowings
String communityId,
String userId,
String filterType,
Integer pageParam,
Integer pageSize
FollowingPage
Returns the specified page of
information about the
specified types of followers of
the specified user. This is
different than
getFollowers, which
returns the users that follow
the specified user.
• communityId—Use null
for communityId.
• userId—Specify the user
Id whose followers you
want to see. Use either the
Id for a user or the
keyword me.
• filterType—Specifies
the key prefix to filter the
type of objects returned.
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.
• pageParam—Specifies the
number of the page you
want returned. Starts at 0.
If you pass in null or 0,
the first page is returned.
• pageSize—Specifies the
number of items per page.
Valid values are between 1
and 1000. If you pass
null, the default size is
25.
getGroups
String communityId,
String userId
UserGroupPage
Returns the first page of
groups the specified user is a
member of. Use null for
communityId. Use either the
Id for a user or the keyword
me. The page contains the
default number of items.
318

Connect in Apex API Reference
ChatterUsers Class
Name
Parameters
Returns
Description
getGroups
String communityId,
String userId,
Integer pageParam,
Integer pageSize
UserGroupPage
Returns the specified page of
groups the specified user is a
member of.
• communityId—Use null
for communityId.
• userId—Specify the user
Id whose followers you
want to see. Use either the
Id for a user or the
keyword me.
• pageParam—Specifies the
number of the page you
want returned. Starts at 0.
If you pass in null or 0,
the first page is returned.
• pageSize—Specifies the
number of items per page.
Valid values are between 1
and 100. If you pass in
null, the default size is
25.
getPhoto
String communityId,
String userId
Photo
Returns information about the
specified user’s photo. Use
null for communityId. Use
either the Id for a user or the
keyword me.
getUser
String communityId,
String userId
UserSummary
Returns information about the
specified user. Use null for
communityId. Use either the
Id for a user or the keyword
me. If the context user is not
a Chatter customer, the
returned object can be
downcast to a UserDetail
object.
getUsers
String communityId
UserPage
Returns the first page of users.
The page contains the default
number of items. Use null
for communityId. If the
context user is a Chatter
customer, the UserPage
UserSummary objects can be
downcast to UserDetail
objects.
getUsers
String communityId,
Integer pageParam,
UserPage
Returns the specified page of
users. Use null for
communityId. If the context
319

Connect in Apex API Reference
ChatterUsers Class
Name
Parameters
Returns
Description
Integer pageSize
user is a Chatter customer, the
UserPage UserSummary
objects can be downcast to
UserDetail objects.
• communityId—Use null
for communityId.
• userId—Specify the user
Id whose followers you
want to see. Use either the
Id for a user or the
keyword me.
• pageParam—Specifies the
number of the page you
want returned. Starts at 0.
If you pass in null or 0,
the first page is returned.
• pageSize—Specifies the
number of items per page.
Valid values are between 1
and 100. If you pass in
null, the default size is
25.
searchUsers
String communityId,
String q
UserPage
Returns the first page of users
that match the specified search
criteria. Use null for
communityId. The page
contains the default number
of items. If the context user is
a Chatter customer, the
UserPage UserSummary
objects can be downcast to
UserDetail objects.
q—Specifies the string to
search. The search string must
contain at least two characters,
not including any wildcards.
For more information about
wildcards, see Using
Wildcards. Can be specified
as null.
searchUsers
String communityId,
String q,
Integer pageParam,
Integer pageSize
UserPage
Returns the specified page of
users that match the specified
search criteria. If the context
user is a Chatter customer, the
UserPage UserSummary
objects can be downcast to
UserDetail objects.
320

Connect in Apex API Reference
ChatterUsers Class
Name
Parameters
Returns
Description
• communityId—Use null
for communityId.
• q—Specifies the string to
search. The search string
must contain at least two
characters, not including
any wildcards. For more
information about
wildcards, see Using
Wildcards. Can be
specified as null.
• pageParam—Specifies the
number of the page you
want returned. Starts at 0.
If you pass in null or 0,
the first page is returned.
• pageSize—Specifies the
number of items per page.
Valid values are between 1
and 100. If you pass in
null, the default size is
25.
setPhoto
String communityId,
String userId,
String fileId,
Integer versionNumber
Photo
Sets the user photo to be the
specified, already uploaded
file.
• communityId—Use null
for communityId.
• userId—Use either the
Id for a user or the
keyword me.
• fileId—ID of a file
already uploaded. The file
must be an image, and be
smaller than 2 MB.
• versionNumber—Version
number of the existing file.
Specify either an existing
version number, or null
to get the latest version.
setPhoto
String communityId,
String userId,
BinaryInput Class
fileUpload
Photo
Sets the provided blob to be
the photo for the specified
user. The content type must
be usable as an image. Use
null for communityId. Use
either the Id for a user or the
keyword me.
321

Connect in Apex API Reference
Records Class
Name
updateChatterSettings
Parameters
String communityId,
String userId,
Enum GroupEmailFrequency
defaultGroupEmailFrequency
Returns
UserChatterSettings
Description
Updates the default Chatter
settings for the specified user.
Don’t pass the value
UseDefault for the
defaultGroupEmailFrequency
parameter because this method
sets the default value.
Use null for communityId.
Use either the Id for a user or
the keyword me.
See Also:
Connect in Apex API Reference
Records Class
Use this class to access information about records in your organization.
Static Methods
Name
Parameters
Returns
Description
getMotif
String communityId,
String idOrPrefix
Motif
Returns a Motif object that contains
the URLs for a set of small, medium,
and large motif icons. Each
Database.com record type has its
own set of motif icons.
• communityId—Use null for
communityId.
• idOrPrefix—An ID or key
prefix.
See Also:
Connect in Apex API Reference
Input Classes
In Connect in Apex, some methods take input objects, which are instances of the following input classes.
322

Connect in Apex API Reference
Input Classes
Input classes are concrete unless marked abstract. Concrete input classes have public constructors that take no arguments.
Some methods take an abstract input object. Construct an instance of a concrete child class to pass to these methods.
Most properties for the input classes can be set. Read–only properties are noted.
BinaryInput Class
Used to attach files to feed items and comments.
Name
blob
contentType
filename
Type
Blob
String
String
Description
Contents of the file to be used for input
MIME type description of the content,
such as image/jpg
File name with the file extension, such
as UserPhoto.jpg
CommentInput Class
Used to add rich comments, for example, comments that include @mentions or attachments.
Name
attachment
body
Type
FeedItemAttachmentInput
MessageBodyInput
Description
Optional. Specifies an attachment for the
comment. Valid values are:
• ContentAttachmentInput
• NewFileAttachmentInput
LinkAttachmentInput is not
permitted for comments.
Description of message body
ContentAttachmentInput Class
Used to attach existing content to a comment or feed item.
Child class of FeedItemAttachmentInput Class
Name
contentDocumentId
Type
String
Description
ID of the existing content.
FeedItemAttachmentInput Class
Used to attach a file to a feed item.
This class is abstract and has no public constructor. You can make an instance only of a child class.
Super class for:
• ContentAttachmentInput Class
• LinkAttachmentInput Class
• NewFileAttachmentInput Class
323

Connect in Apex API Reference
Input Classes
• PollAttachmentInput Class
FeedItemInput Class
Used to add rich feed items, for example, feed items that include @mentions or files. Also used to bookmark a feed item.
Name
attachment
body
isBookmarkedByCurrentUser
visibility
Type
FeedItemAttachmentInput
MessageBodyInput
Boolean
FeedItemVisibilityType Enum
Description
Optional. Specifies the attachment for
the feed item. The feed item type is
inferred based on the provided
attachment.
Message body
Specifies if the new feed item should be
bookmarked for the user (true) or not
(false).
Specifies the type of feed item, such as a
content post, a text post, and so on.
• AllUsers
• InternalUsers
HashtagSegmentInput Class
Used to include a hashtag in a feed item or comment.
Child class of MessageSegmentInput Class
Name
tag
Type
String
Description
Text of the hash tag without the # (hash
tag) prefix
LinkAttachmentInput Class
Used as part of a feed item attachment, to add links.
Child class of FeedItemAttachmentInput Class
Name
url
urlName
Type
String
String
Description
URL to be used for the link
Title of the link
LinkSegmentInput Class
Used to include a link segment in a feed item or comment.
Child class of MessageSegmentInput Class
324

Connect in Apex API Reference
Input Classes
Name
url
Type
String
Description
URL to be used for the link
MentionSegmentInput Class
Used to include an @mention of a user in a feed item or comment.
Child class of MessageSegmentInput Class
Name
id
Type
String
Description
ID of the user to be mentioned
MessageBodyInput Class
Used to add rich messages to feed items and comments.
Name
messageSegments
Type
List
Description
List of message segments contained in
the body
MessageSegmentInput Class
Used to add rich message segments to feed items and comments.
This class is abstract and has no public constructor. You can make an instance only of a child class.
Super class for:
• HashtagSegmentInput Class
• LinkSegmentInput Class
• MentionSegmentInput Class
• TextSegmentInput Class
NewFileAttachmentInput Class
Describes a new file to be attached to a feed item. The actual binary file, that is the attachment, is provided as part of the
BinaryInput in the method that takes this attachment input, such as postFeedItem or postComment.
Child class of FeedItemAttachmentInput Class
Name
description
title
Type
String
String
Description
Description of the file to be uploaded.
File’s title
PollAttachmentInput Class
Used to attach a poll to a feed item.
Child class of FeedItemAttachmentInput Class
325

Connect in Apex API Reference
Output Classes
Name
pollChoices
Type
List
Description
The text labels for the poll items. Polls
must contain between 2 to 10 poll
choices.
TextSegmentInput Class
Used to include a text segment in a feed item or comment.
Child class of MessageSegmentInput Class
Name
text
Type
String
Description
Plain text for this segment. If hashtags
or links are detected in text, they are
included in the comment as hashtag and
link segments. Mentions are not detected
in text and are not separated out of the
text. Mentions require
MentionSegmentInput.
See Also:
Connect in Apex API Reference
Output Classes
In Connect in Apex, most methods produce rich output objects, which are instances of the following output classes.
All properties for all output classes are read-only.
All output classes are concrete unless marked abstract.
All concrete output classes have no-argument constructors that can be invoked from test code only. You can write properties
on these test objects and register values for methods that require test result registration.
Actor Class
Super class for:
• ActorWithId Class
Name
name
type
Type
String
String
Description
Name of the actor, such as the group
name
One of the following:
• file
• group
326

Connect in Apex API Reference
Output Classes
Name
Type
Description
• unauthenticateduser
• user
• record type name—the name of
the record type, such as
myCustomObject__c
ActorWithId Class
Super class for:
• ChatterGroup Class
• FileSummary Class
• RecordSummary Class
• UserSummary Class
Child class of: Actor Class
Name
id
motif
mySubscription
url
Type
String
Motif
Reference
String
Description
Actor’s 18–character Id
An icon that identifies the actor as a user,
group, file, or custom object. The icon
isn’t the user or group photo, and it isn’t
a preview of the file.
If the context user is following the item,
this contains information about the
subscription, else returns null.
Chatter REST API URL for the
resource
Address Class
Name
city
country
formattedAddress
state
street
zip
Type
String
String
String
String
String
String
Description
Name of the city
Name of the country
Formatted address per the locale of the
context user
Name of the state, province, or so on
Street number
Zip or postal code
ApprovalAttachment Class
Child class of FeedItemAttachment Class.
327

Connect in Apex API Reference
Output Classes
Name
id
status
Type
String
WorkflowProcessStatus Enum
Description
A work item ID.
Specifies the status of a workflow process.
• Approved
• Fault
• Held
• NoResponse
• Pending
• Reassigned
• Rejected
• Removed
• Started
BasicTemplateAttachment Class
Child class of FeedItemAttachment Class.
Objects of this type are returned by attachments in FeedItems with type BasicTemplate.
Property
description
icon
linkUrl
subtype
title
Type
String
Icon Class
String
String
String
Description
An optional description with a 500 character limit.
An optional icon.
An optional URL to a detail page if there is additional content
that can’t be displayed inline. Do not specify linkUrl unless
you specify a title.
The subtype associated with the basic template feed item.
Values are:
•
An optional title to the detail page. If linkUrl is specified,
the title links to linkUrl.
ChatterActivity Class
Name
commentCount
commentReceivedCount
likeReceivedCount
Type
Integer
Integer
Integer
Description
Total number of comments in the
organization made by the user
Total number of comments in the
organization received by the user
Total number of likes on posts and
comments in the organization received
by the user
328

Connect in Apex API Reference
Output Classes
Name
postCount
Type
Integer
Description
Total number of posts in the
organization made by the user
ChatterGroup Class
Child class of ActorWithId Class.
Name
canHaveChatterGuests
community
Type
Boolean
Reference
Description
true if this group allows Chatter
Information about the community the
group is in
Note: Communities are
available as a pilot program.
description
fileCount
lastFeedItemPostDate
memberCount
myRole
owner
photo
visibility
String
Integer
Datetime
Integer
GroupMembershipType Enum
UserSummary
Photo
GroupVisibilityType Enum
Group’s description
Number of files posted to this group.
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z of the most
recent feed item posted to the group.
Total number of group members
Specifies the type of membership the user
has with the group, such as group owner,
manager, or member.
• GroupOwner
• GroupManager
• NotAMember
• NotAMemberPrivateRequested
• StandardMember
Information about the owner of the
group.
Information about the group photo
Specifies whether a group is private or
public. Valid values are:
• PrivateAccess
• PublicAccess
329

Connect in Apex API Reference
Output Classes
ChatterGroupPage Class
Name
currentPageUrl
groups
nextPageUrl
previousPageUrl
Type
String
List
String
String
Description
Chatter REST API URL to this page of
groups
List of groups
Chatter REST API URL identifying the
next page of groups
Chatter REST API URL identifying the
previous page of groups
ChatterLike Class
Name
id
likedItem
url
user
Type
String
Reference Class
String
UserSummary
Description
Like’s 18–character Id
A reference to the liked comment or feed
item.
Like’s Chatter REST API URL
Like’s creator
ChatterLikePage Class
Name
currentPageToken
currentPageUrl
likes
nextPageToken
nextPageUrl
previousPageToken
previousPageUrl
total
Type
Integer
String
List
Integer
String
Integer
String
Integer
Description
Token identifying the current page of
likes
Chatter REST API URL identifying the
current page of likes
List of likes
Token identifying the next page of likes
Chatter REST API URL identifying the
next page of likes
Token identifying the previous page of
likes
Chatter REST API URL identifying the
previous page of likes
Total number of likes across all pages
330

Connect in Apex API Reference
Output Classes
ClientInfo Class
Name
applicationName
applicationUrl
Type
String
String
Description
Name of the Connected App used for
authentication.
Value from the Info URL field of the
Connected App used for authentication
Comment Class
Name
attachment
body
clientInfo
createdDate
feedItem
id
isDeleteRestricted
likes
likesMessage
myLike
parent
type
url
Type
FeedItemAttachment
FeedBody
ClientInfo
Datetime
Reference
String
Boolean
ChatterLikePage
MessageBody Class
Reference
Reference
CommentType Enum
String
Description
If the comment contains an attachment,
property value is ContentAttachment.
If the comment does not contain an
attachment, it is null.
Body of the comment
Information about the Connected App
used to authenticate the connection
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
Information about the feed item
Comment’s 18–character Id
If this property is true the comment
cannot be deleted by the context user. If
it is false, it might be possible for the
context user to delete the comment, but
it is not guaranteed.
The first page of likes for the comment
A message body that describes who likes
the comment.
If the context user has liked the
comment, this property is a reference to
the specific like, null otherwise
Information about the parent feed-item
for this comment
Specifies the type of comment.
• ContentComment—the comment
contains an attachment
• TextComment—the comment
contains only text
Chatter REST API URL to this
comment
331

Connect in Apex API Reference
Output Classes
Name
user
Type
UserSummary
Description
Information about the comment author
CommentPage Class
Name
comments
currentPageToken
currentPageUrl
nextPageToken
nextPageUrl
total
Type
List
String
String
String
String
Integer
Description
Collection of comments
Token identifying the first page of
comments.
Chatter REST API URL identifying the
first page of comments, that is, the most
recent comments.
Token identifying the next page of
comments.
Chatter REST API URL identifying the
next page of comments, that is, older
comments.
Total number of comments for the parent
feed item
Community Class
Note: Communities are available as a pilot program.
Name
description
id
invitationsEnabled
name
sendWelcomeEmail
status
url
urlPathPrefix
Type
String
String
Boolean
String
Boolean
CommunityStatus enum
String
String
Description
Community description
Community Id
User can invite other external users to the
community
Community name
Send email to all new users when they
join
Specifies the current status of the
community.
• Active
• Inactive
• UnderConstruction
Full URL to community
Community-specific URL prefix
332

Connect in Apex API Reference
Output Classes
CommunityPage Class
Name
communities
total
Type
List
Integer
Description
List of communities context user has
access to
Total number of communities
ComplexSegment Class
ComplexSegments are only part of field changes.
Super class for FieldChangeSegment Class
Child class of MessageSegment Class
This is an abstract class.
Name
segments
Type
List
Description
List of message segments.
ContentAttachment Class
Child class of FeedItemAttachment Class
Objects of this type are returned by attachments in FeedItems with the type ContentPost.
Name
checkSum
description
downloadUrl
fileExtension
fileSize
fileType
hasImagePreview
hasPdfPreview
id
isInMyFileSync
mimeType
renditionUrl
title
versionId
Type
String
String
String
String
String
String
Boolean
Boolean
String
Boolean
String
String
String
String
Description
MD5 checksum for the file
Description of the attachment
File’s URL
File’s extension
Size of the file in bytes. If size cannot be
determined, returns unknown.
Type of file
true if the file has a preview image
available, otherwise ,false
true if the file has a PDF preview
available, otherwise, false
Content’s 18–character Id
Reserved for future use
File’s MIME type
URL to the file’s rendition resource
Title of the file
File’s version number
333

Connect in Apex API Reference
Output Classes
EntityLinkSegment Class
Child class of MessageSegment Class
Name
motif
reference
Type
Motif
Reference
Description
A set of small, medium, and large icons
that indicate whether the entity is a file,
group, record, or user.
A reference to the link object if
applicable, otherwise, null.
Feed Class
Name
feedItemsUrl
isModifedUrl
Type
String
String
Description
Chatter REST API URL of feed items
A Chatter 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 is not a news feed. Use this URL
to poll a news feed for updates.
FeedBody Class
Child class of MessageBody
No additional properties.
FeedFavorite Class
Name
community
Type
Reference
Description
Information about the community that
contains the favorite
Note: Communities are
available as a pilot program.
createdBy
feedUrl
id
lastViewDate
name
UserSummary
String
String
Datetime
String
Favorite’s creator
Chatter REST API URL identifying the
feed item for this favorite
Favorite’s 18–character Id
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
Favorite’s name
334

Connect in Apex API Reference
Output Classes
Name
searchText
type
url
user
Type
String
String
String
UserSummary
Description
If the favorite is from a search, contains
the search text, otherwise, an empty
string
An empty string or one of the following
values:
• ListView
• Search
Chatter REST API URL to this favorite
Information about the user who saved
this favorite
FeedFavorites Class
Name
favorites
total
Type
List
Integer
Description
Complete list of favorites
Total number of favorites
FeedItem Class
Name
actor
attachment
body
canShare
clientInfo
comments
createdDate
id
isBookmarkedByCurrentUser
isDeleteRestricted
Type
Actor
FeedItemAttachment
FeedBody
Boolean
ClientInfo
CommentPage
Datetime
String
Boolean
Boolean
Description
The entity that created the feed item.
Information about the attachment. If
there is no attachment, returns null.
The body of the feed item.
true if the feed item can be shared,
otherwise, false
Information about the Connected App
used to authenticate the connection.
First page of comments for this feed
item.
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
Feed item’s 18–character Id
true if the current user has bookmarked
this feed item, otherwise, false.
If this property is true the comment
cannot be deleted by the context user. If
it is false, it might be possible for the
335

Connect in Apex API Reference
Output Classes
Name
isEvent
isLikedByCurrentUser
likes
likesMessage
modifiedDate
myLike
originalFeedItem
originalFeedItemActor
parent
photoUrl
preamble
type
Type
Boolean
Boolean
ChatterLikePage
MessageBody Class
Datetime
Reference
Reference
Actor
ActorWithId
String
Message Body
FeedItemType Enum
Description
context user to delete the comment, but
it is not guaranteed.
true if feed item created due to an event
change, otherwise, false
true if the current user has liked this
feed item, otherwise, false
First page of likes for this feed item
A message body the describes who likes
the feed item.
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
If the context user has liked the feed
item, this property is a reference to the
specific like, otherwise, null.
A reference to the original feed item if
this feed item is a shared feed item,
otherwise, null.
If this feed item is a shared feed item,
returns information about the original
poster of the feed item, otherwise, returns
null.
Feed item’s parent
URL of the photo associated with the
feed item
A collection of message segments,
including the unformatted text of the
message that you can use as the title of a
feed item. Message segments include
name, link, and motif icon information
for the actor that created the feed item.
Specifies the type of feed item, such as a
content post, a text post, and so on.
• ActivityEvent
• ApprovalPost
• AttachArticleEvent
• BasicTemplateFeedItem
• ChangeStatusPost
• ChatTranscriptionPost
• CollaborationGroupCreated
• ContentPost
• EmailMessageEvent
• FacebookPost
• LinkPost
336

Connect in Apex API Reference
Output Classes
Name
url
visibility
Type
String
FeedItemVisibilityType Enum
Description
• PollPost
• RypplePost
• ReplyPost
• TextPost
• TrackedChange
• TwitterPost
• UserStatus
Chatter REST API URL to this feed
item
Specifies the type of users who can see a
feed item.
• AllUsers
• InternalUsers
FeedItemAttachment Class
Child classes:
• ApprovalAttachment Class
• BasicTemplateAttachment Class
• ContentAttachment Class
• FeedPoll Class
• LinkAttachment Class
No additional properties. All instances of this class are actually one of the child classes.
This is an abstract class.
The composition of a feed may change between releases. Your code should always be prepared to handle unknown subclasses
in both MessageSegment and FeedItemAttachment objects.
FeedItemPage Class
Name
currentPageToken
currentPageUrl
isModifiedToken
isModifiedUrl
Type
String
String
String
String
Description
Token identifying the first page of feed
items
Chatter REST API URL identifying the
first page of feed items
An opaque polling token to use in the
since parameter of the
ChatterFeeds.isModified method.
The token describes when the feed was
last modified.
A Chatter REST API URL with a
since request parameter that contains
an opaque token that describes when the
337

Connect in Apex API Reference
Output Classes
Name
items
nextPageToken
nextPageUrl
Type
List
String
String
Description
feed was last modified. Returns null if
the feed is not a news feed. Use this URL
to poll a news feed for updates.
List of feed items
Token identifying the next page of feed
items
Chatter REST API URL identifying the
next page of feed items
FeedModifiedInfo Class
Name
isModified
isModifiedToken
nextPollUrl
Type
Boolean
String
String
Description
true if the news feed has been modified
since the last time it was polled; false
otherwise. Returns null if the feed is
not a news feed.
An opaque polling token to use in the
since parameter of the
ChatterFeeds.isModified method.
The token describes when the feed was
last modified.
A Chatter 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 is not a news feed. Use this URL
to poll a news feed for updates. Make a
request to this URL after requesting the
URL in the Feed.isModifiedUrl or
FeedItemPage.isModifiedUrl
property.
FeedPoll Class
Child class of FeedItemAttachment Class.
This object is returned as the attachment of FeedItems with type PollPost.
Name
choices
myChoiceId
Type
List
String
Description
List of choices for poll.
ID of the poll choice that the current user
has voted for in this poll. Returns null
if the current user hasn’t voted.
338

Connect in Apex API Reference
Output Classes
Name
totalVoteCount
Type
Integer
Description
Total number of votes cast on the feed
poll item.
FeedPollChoice Class
Name
id
position
text
voteCount
voteCountRatio
Type
String
Integer
String
Integer
Double
Description
Poll choice Id
The location in the poll where this poll
choice exists. The first poll choice starts
at 1.
Label text associated with the poll choice
Total number of votes for this poll choice
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.
FieldChangeSegment Class
Child class of ComplexSegment Class
No additional properties.
FieldChangeNameSegment Class
Child class of MessageSegment Class
No additional properties.
FieldChangeValueSegment Class
Child class of MessageSegment Class
Name
url
Type
String
Description
URL value if the field change is to a
URL field (such as a web address)
FileSummary Class
Child class of ActorWithId Class
Name
checksum
contentSize
Type
String
Integer
Description
MD5 checksum for the file
Size of the file in bytes
339

Connect in Apex API Reference
Output Classes
Name
contentUrl
description
downloadUrl
fileExtension
fileType
flashRenditionStatus
isInMyFileSync
mimeType
modifiedDate
origin
owner
pdfRenditionStatus
renditionUrl
thumb120By90RenditionStatus
thumb240By180RenditionStatus
thumb720By480RenditionStatus
title
versionNumber
Type
String
String
String
String
String
String
Boolean
String
Datetime
String
UserSummary
String
String
String
String
String
String
String
Description
If the file is a link, returns the URL,
otherwise, the string “null”
Description of the file
URL to the file, that can be used for
downloading the file
Extension of the file
Type of file, such as PDF, PowerPoint,
and so on
Specifies if a flash preview version of the
file has been rendered
Reserved for future use
File’s MIME type
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
Specifies the file source. Valid values are:
• Chatter—file came from Chatter
• Content—file came from content
File’s owner
Specifies if a PDF preview version of the
file has been rendered
URL to the rendition for the file
Specifies if a 120x90–pixel–sized preview
image of the file has been rendered
Specifies if a 240x180–pixel–sized
preview image of the file has been
rendered
Specifies if a 720x480–pixel–sized
preview image of the file has been
rendered
Title of the file
File’s version number
FollowerPage Class
Name
currentPageUrl
followers
Type
String
List
Description
Chatter REST API URL identifying the
current page
List of subscriptions
340

Connect in Apex API Reference
Output Classes
Name
nextPageUrl
previousPageUrl
total
Type
String
String
Integer
Description
Chatter REST API URL identifying the
next page
Chatter REST API URL identifying the
previous page
Total number of followers across all
pages
FollowingCounts Class
Name
people
records
total
Type
Integer
Integer
Integer
Description
Number of people user is following
Number of records user is following
Total number of items user is following
FollowingPage Class
Name
currentPageUrl
following
nextPageUrl
previousPageUrl
total
Type
String
List
String
String
Integer
Description
Chatter REST API URL identifying the
current page
List of subscriptions
Chatter REST API URL of the next
page
Chatter REST API URL of the previous
page
Total number of records being followed
across all pages
GlobalInfluence Class
Name
percentile
rank
Type
String
Integer
Description
Percentile value for the user’s influence
rank within the organization
Number indicating the user’s influence
rank, relative to all other users within the
organization
GroupChatterSettings Class
A user’s Chatter settings for a specific group.
341

Connect in Apex API Reference
Output Classes
Name
emailFrequency
Type
GroupEmailFreqency Enum
Description
The frequency with which a group
member receives email from a group.
GroupMember Class
Name
id
role
url
user
Type
String
GroupMembershipType Enum
String
UserSummary
Description
User’s 18–character Id
Specifies the type of membership the user
has with the group, such as group owner,
manager, or member.
• GroupOwner
• GroupManager
• NotAMember
• NotAMemberPrivateRequested
• StandardMember
Chatter REST API URL to this
membership
Information about the user who is
subscribed to this group
GroupMemberPage Class
Name
currentPageUrl
members
myMembership
nextPageUrl
previousPageUrl
totalMemberCount
Type
String
List
Reference
String
String
Integer
Description
Chatter REST API URL to this page of
members
List of group members
If the context user is a member of this
group, returns information about that
membership, otherwise, null.
Chatter REST API URL identifying the
next page of members
Chatter REST API URL identifying the
previous page of members
Total number of group members across
all pages
342

Connect in Apex API Reference
Output Classes
GroupMembershipRequest Class
Name
createdDate
id
lastUpdateDate
requestedGroup
responseMessage
status
url
user
Type
Datetime
String
Datetime
Reference
String
GroupMembershipRequestStatus
Enum
String
UserSummary
Description
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
ID for the group membership request
object
ISO8601 date string, for example,
2011-02-25T18:24:31.000Z
Information about the group the context
user is requesting to join.
A message for the user if their
membership request is declined. The
value of this property is used only when
the value of the status property is
Declined.
The maximum length is 756 characters.
The status of a request to join a private
group. Values are:
• Accepted
• Declined
• Pending
URL of the group membership request
object.
Information about the user requesting
membership in a group.
GroupMembershipRequests Class
Name
requests
total
Type
List
Integer
Description
Information about group membership
requests.
The total number of requests.
HashtagSegment Class
Child class of MessageSegment Class
Name
tag
Type
String
Description
Text of the hashtag without the hash
symbol (#)
343

Connect in Apex API Reference
Output Classes
Name
url
Type
String
Description
URL search for the tag in the format:
/chatter/feed-items?q=search_text
Icon Class
Property
height
width
url
Type
Integer
Integer
String
Description
The height of the icon in pixels.
The width of the icon in pixels.
The URL of the icon. This URL is available to unauthenticated
users. This URL does not expire.
LinkAttachment Class
Child class of FeedItemAttachment Class
Name
title
url
Type
String
String
Description
Title given to the link if available,
otherwise, null
The link URL
LinkSegment Class
Child class of MessageSegment Class
Name
url
Type
String
Description
The link URL
MentionSegment Class
Child class of MessageSegment Class
Name
accessible
name
user
Type
Boolean
String
UserSummary
Description
Specifies whether the mentioned user can
see mention when it is posted: true if
the mentioned user can see the post,
otherwise, false.
Name of the user mentioned
Information about the mentioned user
344

Connect in Apex API Reference
Output Classes
MessageBody Class
Superclass for FeedBody Class
Name
messageSegments
text
Type
List
String
Description
List of message segments that make up
this message
Formatted text of the message. This can
be an easy summary to use if you don’t
want to process all the message segments.
MessageSegment Class
Superclass for:
• ComplexSegment Class
• EntityLinkSegment Class
• FieldChangeSegment Class
• FieldChangeNameSegment Class
• FieldChangeValueSegment Class
• HashtagSegment Class
• LinkSegment Class
• MentionSegment Class
• MoreChangesSegment Class
• ResourceLinkSegment Class
• TextSegment Class
This is an abstract class.
The composition of a feed may change between releases. Your code should always be prepared to handle unknown subclasses
in both MessageSegment and FeedItemAttachment objects.
Name
text
type
Type
String
MessageSegmentType Enum
Description
Formatted text of the message.
Textual summary of the message
segment. The values correspond to the
different child classes. Value are:
• EntityLink
• FieldChange
• FieldChangeName
• FieldChangeValue
• Hashtag
• Link
• Mention
• MoreChanges
• Text
345

Connect in Apex API Reference
Output Classes
MoreChangesSegment Class
Child class of MessageSegment Class
In feed items with a large number of tracked changes, the message is formatted as: "changed A, B, and made X more changes."
The MoreChangesSegment contains the "X more changes."
Name
moreChangesCount
Type
Integer
Description
Number of additional changes
Motif
Each property in the motif class contains a URL to a small, medium, and large icon that indicates the Database.com record
type. Common record types in Chatter 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.
Note: 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": {
"largeIconUrl": "/img/icon/custom51_100/boat64.png",
"mediumIconUrl": "/img/icon/custom51_100/boat32.png",
"smallIconUrl": "/img/icon/custom51_100/boat16.png"
},
Users use the following icons:
"motif": {
"largeIconUrl": "/img/icon/profile64.png",
"mediumIconUrl": "/img/icon/profile32.png",
"smallIconUrl": "/img/icon/profile16.png"
},
Groups use the following icons:
"motif": {
"largeIconUrl": "/img/icon/groups64.png",
"mediumIconUrl": "/img/icon/groups32.png",
"smallIconUrl": "/img/icon/groups16.png"
},
Files use the following icons:
"motif": {
"largeIconUrl": "/img/content/content64.png",
"mediumIconUrl": "/img/content/content32.png",
"smallIconUrl": "/img/icon/files16.png"
},
Note: To view the icons in the previous examples, preface the URL with https://instance_name. For example,
https://instance_name/img/icon/profile64.png.
346

Connect in Apex API Reference
Output Classes
Name
largeIconUrl
mediumIconUrl
smallIconUrl
Type
String
String
String
Description
A large icon indicating the record type.
A medium icon indicating the record
type.
A small icon indicating the record type.
PhoneNumber Class
Name
phoneNumber
type
Type
String
String
Description
Phone number
Values are:
• Fax
• Mobile
• Work
Photo Class
Name
fullEmailPhotoUrl
largePhotoUrl
photoVersionId
smallPhotoUrl
standardEmailPhotoUrl
url
Type
String
String
String
String
String
String
Description
A temporary URL to the large profile
picture. The URL expires after 30 days
and is available to unauthenticated users.
URL to the large profile picture. The
default width is 200 pixels, and the
height is scaled so the original image
proportions are maintained.
18–character Id to that version of the
photo
URL to the small profile picture. The
default size is 64x64 pixels.
A temporary URL to the small profile.
The URL expires after 30 days and is
available to unauthenticated users.
A resource that returns a Photo object:
for example,
/services/data/v27.0/chatter/users/005D0000001LL8OIAW/photo.
RecordSummary Class
Child class of ActorWithId Class
No additional properties. This is a generic record which doesn’t have special child classes.
347

Connect in Apex API Reference
Output Classes
Reference Class
Child class of MessageSegment Class
Name
id
url
Type
String
String
Description
18–character id of the object being
referenced
URL to the resource
ResourceLinkSegment Class
Name
url
Type
String
Description
URL to the resource
Subscription Class
Name
community
id
subject
subscriber
url
Type
Reference
String
Actor
Actor
String
Description
Information about the community in
which the subscription exists
Subscription’s 18–character Id
Information about the parent, that is, the
thing or person being followed
Information about the subscriber, that
is, the person following this item
Chatter REST API URL to this specific
subscription
TextSegment Class
Child class of MessageSegment Class
No additional properties.
UserChatterSettings Class
A user’s global Chatter settings.
Name
defaultGroupEmailFrequency
Type
GroupEmailFrequency Enum
Description
The default frequency with which a user
receives email from a group when they
join it.
UserDetail Class
Child class of UserSummary Class
348

Connect in Apex API Reference
Output Classes
Name
aboutMe
address
chatterActivity
chatterInfluence
email
followersCount
followingCounts
groupCount
managerId
managerName
phoneNumbers
username
Type
String
Address
ChatterActivity
GlobalInfluence
String
Integer
FollowingCounts
Integer
String
String
List
String
Description
Text from user's profile
User’s address
Chatter activity statistics
User’s influence rank
User's email address
Number of users following this user
Information about items the user is
following
Number of groups user is following
18–character Id of the user’s manager
Locale-based concatenation of manager's
first and last names
Collection of user's phone numbers
Username of the user, such as
Admin@mycompany.com.
UserGroupPage Class
Name
currentPageUrl
groups
nextPageUrl
previousPageUrl
total
Type
String
List
String
String
Integer
Description
Chatter REST API URL identifying the
current page
List of groups
Chatter REST API URL of the next
page
Chatter REST API URL of the previous
page
Total number of groups across all pages
UserPage Class
Name
currentPageToken
currentPageUrl
nextPageToken
nextPageUrl
Type
Integer
String
Integer
String
Description
Token identifying the current page
Chatter REST API URL identifying the
current page
Token identifying the next page
Chatter REST API URL identifying the
next page
349

Connect in Apex API Reference
Output Classes
Name
previousPageToken
previousPageUrl
users
Type
Integer
String
List
Description
Token identifying the previous page
Chatter REST API URL identifying the
previous page
List of user detail information. The items
in this list can be downcast to
UserDetails if the context user is not a
Chatter customer.
UserSummary Class
Super class of UserDetail Class.
Child class of ActorWithId Class.
Name
companyName
firstName
isActive
isChatterGuest
lastName
photo
title
userType
Type
String
String
Boolean
Boolean
String
Photo
String
UserType Enum
Description
Name of the company
User's first name
true if user is active, otherwise, false.
true if user is a Chatter customer
User's last name
Information about the user's photos
User’s title
Specifies the type of user.
• ChatterGuest—User is a Chatter
customer in an external group
• Guest—Unauthenticated users
• Internal—User is a tandard
organization member
• Portal—User is a Customer Portal
User, a communities user, and so on.
• System—User is Chatter Expert or
a system user
See Also:
Connect in Apex API Reference
350

Connect in Apex API Reference
Enums
Enums
An enum is data type whose values are constants. Use enums to define a fixed set of values that don’t have a numerical order,
such as playing card suits or the seasons of the year.
Connect in Apex enums inherit all properties and methods of Apex enums.
Connect in Apex provides the following enums:
Enum
CommentType
CommunityStatus
Description
Specifies the type of comment.
• ContentComment—the comment contains an attachment
• TextComment—the comment contains only text
Specifies the current status of the community.
• Active
• Inactive
• UnderConstruction
Note: Communities are available as a pilot program.
FeedFavoriteType
FeedItemAttachmentType
FeedItemType
Specifies the origin of the feed favorite, such as whether it’s a
search term or a list view:
• ListView
• Search
Specifies the type of the attachment, such as a link or a new
file:
• Approval
• BasicTemplate
• CaseComment
• Content
• DashboardComponent
• ExistingContent
• Link
• NewFile
• Poll
Specifies the type of feed item, such as a content post, a text
post, and so on.
• ActivityEvent
• ApprovalPost
• AttachArticleEvent
• BasicTemplateFeedItem
• ChangeStatusPost
• ChatTranscriptionPost
351

Connect in Apex API Reference
Enums
Enum
Description
• CollaborationGroupCreated
• ContentPost
• EmailMessageEvent
• FacebookPost
• LinkPost
• PollPost
• RypplePost
• ReplyPost
• TextPost
• TrackedChange
• TwitterPost
• UserStatus
FeedItemVisibilityType
FeedSortOrder
FeedType
GroupEmailFrequency
Specifies the type of users who can see a feed item.
• AllUsers
• InternalUsers
Specifies the order returned by the sort, such as by date created
or last modified:
• CreatedDateDesc
• LastModifiedDateDesc
Specifies the type of feed, such as a feed made up of
bookmarks, groups, or records:
• Bookmarks
• Company
• Files
• Groups
• News
• People
• Record
• To
• UserProfile
Specifies the frequency with which a user receives email from
a group.
• EachPost
• DailyDigest
• WeeklyDigest
• Never
• UseDefault
Do not use the value UseDefault in the
ChatterUsers.updateChatterSettings method
because this method sets the default value.
352

Connect in Apex API Reference
Enums
Enum
GroupMembershipType
GroupMembershipRequestStatus
GroupVisibilityType
MessageSegmentType
UserType
WorkflowProcessStatus
Description
Specifies the type of membership the user has with the group,
such as group owner, manager, or member.
• GroupOwner
• GroupManager
• NotAMember
• NotAMemberPrivateRequested
• StandardMember
The status of a request to join a private group.
• Accepted
• Declined
• Pending
Specifies whether a group is private or public.
• PrivateAccess
• PublicAccess
Specifies the type of message segment, such as text, link, field
change name, or field change value.
• EntityLink
• FieldChange
• FieldChangeName
• FieldChangeValue
• Hashtag
• Link
• Mention
• MoreChanges
• ResourceLink
• Text
Specifies the type of user.
• ChatterGuest—User is a Chatter customer in an
external group
• Guest—Unauthenticated users
• Internal—User is a tandard organization member
• Portal—User is a Customer Portal User, a communities
user, and so on.
• System—User is Chatter Expert or a system user
Specifies the status of a workflow process.
• Approved
• Fault
• Held
• NoResponse
• Pending
• Reassigned
353

Connect in Apex API Reference
Exceptions
Enum
Description
• Rejected
• Removed
• Started
See Also:
Connect in Apex API Reference
Exceptions
All exceptions support built-in methods for returning the error message and exception type. In addition to the standard
exception class, Connect in Apex supports the following exceptions:
Exception
ConnectApiException
NotFoundException
RateLimitException
Description
Any logic error in the way your application is utilizing Connect
in Apex. This is equivalent to receiving a 400 error with
Chatter API in REST.
Any issues with the specified resource being found. This is
equivalent to receiving a 404 error with Chatter API in REST.
When you exceed the rate limit. This is equivalent to receiving
a 503 Service Unavailable error with Chatter API in REST.
For more information on using exceptions in Apex, see “Using Exception Methods” in Force.com Apex Code Developer's Guide.
See Also:
Connect in Apex API Reference
354

Index
Index
@ me resources 157
A
Access tokens 21
Activity response body 220
Adding member to a group 107
Adding photo
group 114
user 193
Address response body 219
Approval
feed item attachment 231
Attach input
existing content 206
feed poll 206
link 207
new file upload 207
B
Batch information
group-memberships resource 97
Batch results
item response body 219
response body 219
Batching information
groups 105
result item response body 219
results response body 219
users 174
Bearer token 22
Bookmarks
feed items 48
feed URL 47
flat feed 51
resources 47
C
Chatter API
cURL 13
differences with other APIs 2
how to example 28
named resources 7
quick reference 28
resources 2
rich input 8
selecting the right API 2
URLs 7
using 2
wildcards 12
Chatter resource 52
Chatter response bodies
activity 220
directory 221
influence 221
ClientInfo response body 221
Comments
access 53
delete 53
input 208
likes 55
on feed items 73
page response body 222
resources 53
response body 221
Communities
building URL 7
Company feed
feed items 57
resources 56
URL 56
Connect
resource 58
Conversations
change status 177
detail response body 224
input 218
summary collection response body 225
summary detail response body 224
unread count 178
unread count response body 225
D
Dashboard component snapshot
input 209
Deleting photo
group 114
user 193
Directory response body 221
E
Error message response body 225
Error responses 263
Error with output
response body 225
Examples
@mentions 39
activity status 35
add comments 30
batch 39
filter a response body 28
follow record 38
following list 35
get feed items for a record 35
get the news feed 34
Java 131
join group 36
join private group 37
like feed items 32
link post 131
355

Examples (continued)
poll news feed for updates 33
post @mentions 30
post multiple @mentions 31
post to group 37
recommendations 36
request to join private group 36
search a group feed 34
search a record feed 34
send private message 38
share a feed item 32
unfollow record 38
uploading binary files 8
user name autocomplete 39
Explanation
details response body 226
summary response body 226
F
Favorite
input 210
page response body 227
response body 226
Favorites feed
feed items 64
list of favorites 60
resources 60
specific favorite 62
Features response body 227
Feed item attachment
approval response body 231
basic template response body 232
content response body 232
link response body 233
poll response body 233
Feed items
accessing 69
bookmark feed 48
bookmarking 69
company feed 57
deleting 69
favorites feed 64
files feed 87
groups feed 95
input 211
key prefix filtered feed 92
news feed 123
people feed 135
record feed 139
response body 229
to feed 158
user-profile feed 162
Feed response bodies
feed 228
feed body 228
feed directory 228
feed directory item 229
feed item 229
feed item page 233
feed item preamble 234
feed modified info 234
Feed response bodies (continued)
feed poll choice 234
Feed-items resources
accessing specific feed item 69
comments 73
likes 77
polls 78
query 68
resources 67
Feeds
bookmarks resources 47
company resources 56
favorites resources 60
files resources 86
filter resources 90
groups resources 94
list resource 65
news resource 120
people resources 134
record resource 138
share an item 32
to resources 157
topics resource 160
user-profile resources 161
users resource 170
Files
feed item response body 237
file details response body 236
file page response body 236
file response body 235
files shares page response body 237
group files 105
input 212
library response body 242
uploading binary example 8
Files feed
feed items 87
flat feed 88
resources 86
URL 86
Files resources
content 82
file information in batch 86
rendition 85
shares 82
specific file information 79
user files, filtered by groups 181
user files, filtered by sharing 182
user files, general 178
Filter a response body 28
Filter feed
flat feed 93
key prefix 91
key prefix feed items 92
list of filters 90
resources 90
Filter response bodies 258
Flat feed
bookmarks feed 51
files feed 88
filtered feed 93
groups feed 96
Index
356

Flat feed (continued)
news feed 132
people feed 136
record feed 153
response body 237
to feed 159
user-profile feed 169
Follow record example 38
Followers
follower page response body 237
record resource 155
users resources 183
Following
following counts response body 238
following page response body 238
input 213
records 184
users 184
G
Group chatter settings
input 213
response body 239
Group member
input 214
page response body 240
response body 240
Group membership
request collection response body 241
request response body 240
Group Membership Request Update
input 214
Group-memberships batch resource 97
Group-memberships resource 97
Groups
joining example 36
joining private group example 37
page response body 241
posting example 37
requesting membership 113
requesting membership in a private group 110
requesting status for membership requests 110
requesting to join private group example 36
response body 238
Groups feed
feed items 95
flat feed 96
resources 94
URL 94
Groups resources
batching information 105
files information 105
groups in organization 101
information 103
members 107
members requests for private groups 110
membership request 113
photo 114
settings 116
H
Hash tags
message segment input 215
message segment response body 246
I
Icon response body 241
Influence
resource 117
response body 221
thresholds response body 242
Inputs
attachment:existing content 206
attachment:feed poll 206
attachment:link 207
attachment:new file upload 207
comments 208
conversation 218
dashboard component snapshot 209
favorite 210
feed item 211
feed poll input 212
file input 212
following 213
group chatter settings 213
group member 214
group membership request update 214
message body 215
message segment:hash tag 215
message segment:link 215
message segment:mention 215
message segment:text 216
messages 217
PATCH 8
photo 216
POST 8
PUT 8
user chatter settings 216
user message:recipient 217
user message:recipient list 218
J
Java example 131
L
Library response body 242
Likes
access 118
delete 118
message response body 242
on comments 55
on feed item 77
page response body 243
resource 118
response body 242
Link post examples 131
Links
attachment input 207
Index
357

Links (continued)
feed item attachment 233
message segment input 215
message segment response body 246
M
Members of a group 107
Mentions
message segment input 215
message segment response body 246
Message body input 215
Message segment input
hash tag 215
link 215
mention 215
text 216
Message segment response body
entity links 244
field change 245
field change name 245
field change value 245
hashtag 246
link 246
mention 246
more changes 247
resource link 247
text 247
Messages
collection response body 244
input 217
response body 243
user messages, specific 192
Motif
response body 248
Motifs
batch motifs resource 120
resource 119
Motifs resources 119
N
New file upload 207
News feed
feed items 123
flat feed 132
is-modified 122
polling for updates 122
polling for updates example 33
resources 120
URL 121
O
OAuth
authentication 26
user-agent flow 19
Web server flow 15
Organization
resource 59
response body 249
response body, summary 249
P
Parent response body 249
PATCH input 8
People feed
feed items 135
flat feed 136
resources 134
URL 135
Phone number response body 249
Photo
group 114
input 216
response body 250
user 193
Polling news feed for updates 33
Polls
attachment input 206
feed item attachment 233
feed poll choice response body 234
feed poll input 212
on feed items 78
POST input 8
PUT input 8
Q
Query feed items 68
Quick reference 28
Quickstart
access token 25
OAuth 25
prerequisites 25
R
Index
Recipient
input 217
list input 218
Recommendations
response body 250
specific action 197
specific action and key prefix 199
specific action and object category 197
specific action and object ID 200
Record feed
feed items 139
flat feed 153
resources 138
URL 138
Records
followers 155
following 184
record information 154
resources 154
RecordsResponse bodies
record summary 251
summary response body 251
Reference response body 251
Refresh tokens 21
Request bodies
attachment:existing content 206 358

Request bodies (continued)
attachment:feed poll 206
attachment:link 207
attachment:new file upload 207
comments 208
conversation 218
dashboard component snapshot 209
favorite 210
feed item 211
feed poll input 212
file input 212
following 213
group chatter settings 213
group member 214
group membership request update 214
message body 215
message segment:hash tag 215
message segment:link 215
message segment:mention 215
message segment:text 216
messages 217
photo 216
user chatter settings 216
user message:recipient 217
user message:recipient list 218
Requesting membership in a group 113
Requesting membership in a private group 110
Resource link
message segment response body 247
Resources
batch motifs 120
bookmarks 47
chatter 52
comments 53
company feed 56
connect 58
error responses 263
favorites 60
feed-items 67
feeds 65
files 79
files feed 86
filter feed 90
groups feed 94
influence 117
likes 118
motifs 119
organization 58
people feed 134
records 154
relationships 44
response bodies 219
returns 219
subscriptions 156
Response bodies
address 219
batch result item 219
batch results 219
chatter activity 220
chatter directory 221
chatter influence 221
Response bodies (continued)
clientinfo 221
comment 221
comment page 222
conversation detail 224
conversation summary 224
conversation summary collection 225
conversation unread count 225
error message 225
error with output 225
explanation details 226
explanation summary 226
favorite 226
favorites page 227
features 227
feed 228
feed body 228
feed directory 228
feed directory item 229
feed item 229
feed item attachment:approval 231
feed item attachment:basic template 232
feed item attachment:content 232
feed item attachment:link 233
feed item attachment:poll 233
feed item page 233
feed item preamble 234
feed modified info 234
feed poll choice 234
file 235
file details 236
file page 236
file shares page 237
filtering 258
flat feed 237
flat feed item 237
follower page 237
following counts 238
following page 238
group 238
group chatter settings 239
group member 240
group member page 240
group membership request 240
group membership request collection 241
group page 241
icon 241
influence thresholds 242
library 242
like 242
like message body 242
like page 243
message 243
message collection 244
message segment:entity link 244
message segment:field change 245
message segment:field change name 245
message segment:field change value 245
message segment:hashtag 246
message segment:link 246
message segment:mention 246
Index
359

Response bodies (continued)
message segment:more changes 247
message segment:resource link 247
message segment:text 247
motif 248
organization 249
organization summary 249
parent 249
phone number 249
photo 250
recommendation 250
reference 251
shares 251
subscription 252
subscription page 252
topics 253
user chatter settings 253
user detail 253
user group page 255
user page 255
user settings 255
user status 256
user summary 256
Rich input 8
S
Search feed items 68
Selecting the right API 2
Settings
group 116
users 201
Shares response body 251
Subscribing to a group 107
Subscriptions
page response body 252
resource 156
response body 252
T
Text
message segment input 216
message segment response body 247
To feed
feed items 158
flat feed 159
resources 157
URL 158
Tokens 21–22
Topics
resource 160
response body 253
trending topics resource 160
U
Unfollow record example 38
Updating photo
group 114
user 193
Uploading binary files 8
URLs 7
User chatter settings
input 216
response body 253
User detail 257
User response bodies
user detail 253
user group page 255
user page 255
user settings 255
user status 256
user summary 256
User summary 257
User-agent OAuth flow 19
User-profile feed
feed items 162
flat feed 169
resources 161
URL 161
Users resources
batching information 174
conversations 174
conversations, change status 177
conversations, specific 176
conversations, unread count 178
files, filtered by groups 181
files, filtered by sharing 182
files, general 178
followers 183
following records 184
following users 184
groups 186
messages 186
messages, specific 192
photo 193
recommendations 194
recommendations for specific action 197
recommendations for specific action and object ID 200
recommendations, specific action and key prefix 199
recommendations, specific action and object category 197
user information 172
user profile information 173
user settings 201
user status 203
W
Web server OAuth flow 15
Wildcards 12
Index
360