Chatter REST API Developer Guide

Chatter REST API Developer Guide
Introduction
Quick Start
Work with Features
Examples
Resources
Request Bodies
Response Bodies
Action Link Definition
Action Link Diagnostic
Action Link Group Definition
Activity Reminder
Activity Reminders Collection
Address
Alternative
Announcement
Announcement Page
Approval Capability
Approval Post Template Field
Approval Social Post Intent
Article Item
Article Summary
Asset File
Associated Actions Capability
Async Query
Async Query Collection
Audience
Audience Collection
Audience Criteria Details
Audience Criterion Details
Audience Target
Audience Target Assignment
Banner Capability
Banner Photo
Batch Result Item
Batch Results
Bookmarks Capability
Bookmark Summary
Candidate Answers Status
Case Comment Capability
Canvas Capability
Capture Gateway Response Output
Capture Output
Change Item Output
Chatter Activity
Chatter Activity Summary
Chatter Directory
Chatter Influence
Chatter Likes Capability
Chatter Recommendation
Chatter Recommendations
Chatter Stream
Chatter Stream Collection
Clean Record Result
Clean Record Result Collection
Clean Rule Data Service
Clean Rule Data Service Collection
Clean Rule Data Service Metrics
Clean Rule Data Service Metrics Collection
Clean Rule Status
Clean Rule Status Collection
ClientInfo
Close Capability
Comment
Comment Summary
Comment Capabilities
Comment Page
Comments Capability
Community
Community Create
Community Page
Community Publish
Community Summary
Community Template
Community Template Collection
Company Verify Summary
Connect Directory
Content
Content Capability
Conversation Detail
Conversation Summary
Conversation Summary Collection
Conversation Unread Count
Create Credit Memo Output
Create Order Payment Summary Output
Custom List Audience Criteria
Custom Recommendation Audience
Custom Recommendation Audience Collection
Custom Recommendation Definition
Custom Recommendation Definition Collection
Dashboard Component Snapshot
Dashboard Component Snapshot Capability
Datacloud Company
Datacloud Company Collection
Datacloud Contact
Datacloud Contact Collection
Datacloud Import
Datacloud Import Status
Datacloud Order
Datacloud Purchase Usage
Data Integration Credit
Data Integration Credit Objects
Delete Intent
Delete Intents
Delete Social Post Intent
Digest Job
Direct Message Capability
Direct Message Member Collection
Direct Message Membership Activity
Direct Message Membership Activity Collection
Downvote Summary
Duplicate Directory
Duplicate Job
Duplicate Job Collection
Duplicate Job Definition
Duplicate Job Definition Collection
Edit Capability
Email Address
Email Attachment
Email Merge Field
Email Merge Field Collection
Email Message Capability
Emoji
Emoji Collection
Enhanced Link Capability
Ensure Funds Async Output
Ensure Refunds Async Output
Entity Label
Environment Hub My Domain Validation
Environment Hub OAuth URL
Environment Hub Sign-up Member Validation
Environment Hub SSO User Mapping Validation
Error Message
Error Response Output
Error with Output
Explanation Details
Explanation Summary
Extension
Extension Definition
Extension Definition Collection
Extensions Capability
External File Permission Information
Favorite
Favorites Page
Features
Feed
Feed Directory
Feed Directory Item
Feed Element Capabilities
Feed Element Page
Feed Enabled Entity Summary
Feed Entity Is Editable
Feed Entity Not Available Summary
Feed Entity Read Summary
Feed Entity Share Capability
Feed Item
Feed Item Body
Feed Item Preamble Message Body
Feed Item Summary
Feed Modified Info
Feed Poll Choice
Feed Post Summary
Feed Read Summary
Feed Tracked Change
File Detail
File Preview
File Preview Collection
File Preview URL
File Share Link
File Shares Page
File Summary
File Summary Page
Files Capability
Files Connect Allowed Item Type Collection
Files Connect Field Definition
Files Connect Item Type Detail
Files Connect Item Type Summary
Files Connect Permission
Files Connect Permission Collection
Files Connect Permission Type
Files Connect Provider Type
Files Connect Repository
Files Connect Repository Authentication
Files Connect Repository Collection
Files Connect Repository Features
Flat Feed
Flat Feed Item
Folder
Folder Item
Folder Item Page
Folder Path
Folder Share Link
Follow Social Persona Intent
Follow Social Persona Intents
Follower Page
Following Counts
Following Page
Forecasting Ancestors
Forecasting Manager
Forecasting Manager Ancestors
Forecasting My Forecasts
Forecasting My Forecasts Collection
Forecasting User
Forecasting User Access
Forecasting User Access Collection
Forecasting User Collection
Fulfillment Order Cancel Line Items Output
Fulfillment Order Invoice Output
Fulfillment Order Output
Gateway Log Output
Generic Bundle Capability
Generic Feed Element
Group
Group Chatter Settings
Group Detail
Group Information
Group Member
Group Member Page
Group Membership Request
Group Membership Request Collection
Group Page
Group Record
Group Record Page
Hide Social Post Intent
Icon
Image File
Image File Detail
Influence Thresholds
Interactions Capability
Invite
Invite Collection
Knowledgeable People
Knowledgeable People Collection
Knowledge Article Version
Knowledge Article Version Collection
Lightning Extension Information
Like
Like Intent
Like Message Body
Like Page
Like Intents
Like Social Post Intent
Like Summary
Link Capability
Link Metadata
Link Metadata Collection
List Current Share Collection
List Share
List Share Category
List Share Collection
List View Column
List View Definition
List View Object
List View Record
List View Sort
Maintenance Information
Managed Content Associations
Managed Content Channel (Beta)
Managed Content Channel Collection (Beta)
Managed Content Date and Time Node Value
Managed Content Date Node Value
Managed Content Media Node Value
Managed Content Node Type
Managed Content Search Result
Managed Content Search Result Collection
Managed Content Search Result Content Type
Managed Content Text Node Value
Managed Content Type
Managed Content Version
Managed Content Version Collection
Managed Social Account
Managed Social Accounts
Managed Social Account Setup
Managed Social Accounts Setup
Managed Social Account Setup Authentication
Managed Topic
Managed Topic Collection
Media Reference
Media Reference Capability
Mention Completion
Mention Completion Page
Mention Validation
Mention Validations
Message
Message Collection
Message Segment: Entity Link
Message Segment: Field Change
Message Segment: Field Change Name
Message Segment: Field Change Value
Message Segment: Hashtag
Message Segment: Inline Image
Message Segment: Link
Message Segment: Markup Begin
Message Segment: Markup End
Message Segment: Mention
Message Segment: More Changes
Message Segment: Resource Link
Message Segment: Text
Messaging Channel
Messaging Channels
Moderation Audit Record Count
Moderation Capability
Moderation Flag Item
Moderation Flags
Moderation Flags Collection
Motif
Mute Capability
Mute Summary
Navigation Menu Item
Navigation Menu Item Collection
New User Audience Criteria
Next Best Action Flow Action
Next Best Action Parameter
Next Best Action Native Recommendation
Next Best Action Recommendation
Next Best Action Recommendations
Notification App Setting
Notification App Settings Collection
Notification Member
Notification Setting
Notification Settings Collection
OAuth User
OAuth Provider
Order Summary Output
Organization
Origin Capability
Out of Office
Payment Group Output
Payment Output
Phone Number
Photo
Pin Capability
Pinned Feed Element Collection
Platform Action
Platform Action Group
Poll Capability
Preview Cancel Output
Preview Return Output
Question and Answers Capability
Question and Answers Suggestion Collection
Read By
Read By Capability
Read By Collection
Recommendation Object
Recommendation Reaction
Recommendation Reaction Collection
Recommendations Capability
Recommended Object
Record Capability
Record Field
Record Field: Blank
Record Field: Compound
Record Field: Currency
Record Field: Date
Record Field: Percent
Record Field: Picklist
Record Field: Reference
Record Field: Reference with Date
Record Snapshot
Record Snapshot Capability
Record Summary
Record Summary List
Record View
Record View Section
Reference
Refund Gateway Response Output
Refund Output
Referenced Refund Service Output
Related Feed Post
Related Feed Post Collection
Related Question
Reply Social Post Intent
Reply Social Post Intents
Repository Directory Entry Collection
Repository File Detail
Repository File Summary
Repository Folder Detail
Repository Folder Item
Repository Folder Items Collection
Repository Folder Summary
Repository Group Summary
Repository Permission Type Collection
Repository User Summary
Reputation
Reputation Level
Request Header
Scheduled Custom Recommendation
Scheduled Custom Recommendation Collection
Service Appointment Output
Service Appointment Result
Service Territories List Result
Service Territories Output
Service Territories Result
Scope
Share Captured Activity Result
Shares
Social Account
Social Account Relationship
Social Customer Service Configuration
Social Customer Service Message Type Settings
Social Customer Service Provider Settings
Social Post Capability
Social Post Intents
Social Post Mass Approval
Social Post Status
Stamp
Status Capability
Strategy Trace
Strategy Trace Node
Submit Cancel Output
Submit Return Output
Subscription
Subscription Page
Supported Emojis
Target
Target Collection
Terms of Service
Time Zone
Topic
Topic Collection
Topic Endorsement
Topic Endorsement Collection
Topic Endorsement Summary
Topic Images
Topic Opt Out
Topic Opt Out Collection
Topic Suggestion
Topic Suggestion Collection
Topic Summary
Topics Capability
Topics People Are Knowledgeable About
Topics People Are Knowledgeable About Collection
Tracked Change Bundle Capability
Tracked Changes Capability
Unauthenticated User
Up Down Vote Capability
Upvote Summary
User Activities Job
User Activity Collection
User Capabilities
User Chatter Settings
User Detail
User Group Detail Collection
User Group Page
User Mission
User Mission Activities Job
User Mission Activity
User Mission Activity Collection
User Mission Activity Status
User Page
User Profile
User Profile Tab
User Reference Collection
User Settings
User Status
User Summary
Verified Capability
Vote
Vote Collection
Workspace Permission
Zone
Zone Page
Zone Search Page
Zone Search Result
Appendices
PDF

Newer Version Available

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

Audience

An audience.
Property Name Type Description Filter Group and Version Available Version
criteria Audience Criteria Details[] Criteria details for the audience. Medium, 47.0 47.0
customFormula String Custom formula for the audience criteria. For example, (1 AND 2) OR 3. Small, 47.0 47.0
formulaFilter​Type String Formula filter type for the personalization audience. Values are:
  • AllCriteriaMatch—All audience criteria are true (AND operation).
  • AnyCriterionMatches—Any audience criterion is true (OR operation).
  • CustomLogicMatches—Audience criteria match the custom formula (for example, (1 AND 2) OR 3).
 Small, 47.0 47.0
id String ID of the audience. Small, 47.0 47.0
name String Name of the audience. Small, 47.0 47.0
targets Audience Target Assignment[] Target assignments for the audience. Small, 47.0 47.0
url String URL to this audience. Small, 47.0 47.0