Chatter REST API Developer Guide

Introducing Chatter REST API
Chatter REST API Quick Start
Chatter REST API Features
Chatter REST API Examples
Chatter REST API Resources
Chatter REST API Request Bodies
Action Link Definition Input
Action Link Group Definition Input
Action Link Input
Action Link Template Binding Input
Announcement Input
Associated Actions Capability Input
Async Query Input
Attachment Input: Canvas App
Attachment Input: Existing Content
Attachment Input: Feed Poll
Attachment Input: Link
Attachment Input: New File Upload
Banner Photo Input
Batch Collection Input
Batch Input
Bookmarks Capability Input
Canvas Capability Input
Clean Input
Comment Input
Comment Capabilities Input
Content Capability Input
Custom List Audience Criteria Input
Datacloud Contact Import Input
Datacloud Order Input
Dashboard Component Snapshot Input
Digest Job Input
Environment Hub SSO User Mapping Input
Feed Element Capabilities Input
Feed Favorite Input
Feed Item Input
Feed Item Topic Input
Feed Poll Input
File Input
File ID Input
Files Capability Input
File Shares Input
Files Connect Field Value Input
Files Connect Item Input
Files Connect Permission Collection Input
Files Connect Permission Input
Folder Input
Folder Item Input
Following Input
Generic Batch Collection Input
Generic Batch Input
Group Chatter Settings Input
Group Information Input
Group Input
Group Member Input
Group Membership Request Update
Group Record Input
Link Capability Input
Managed Topic Input
Managed Topic Position Collection Input
Managed Topic Position Input
Message Body Input
Message Segment Input: Hash Tag
Message Segment Input: Inline Image
Message Segment Input: Link
Message Segment Input: Markup Begin
Message Segment Input: Markup End
Message Segment Input: Mention
Message Segment Input: Text
Moderation Flag Input
Mute Capability Input
New User Audience Criteria Input
Notification Member Input
Photo Input
Poll Capability Input
Push Notification Input
Question and Answers Capability Input
Recommendation Audience Input
Recommendation Definition Input
Request Header Input
Scheduled Recommendation Input
Share Input
Status Capability Input
Topic Assignment Input
Topic Endorsement Input
Topic Input
Topic Names Input
Topics Capability Input
User Chatter Settings Input
User ID Collection Input
User Input
User Message
User Message Recipient Input
User Message Recipient List Input
User Status Input
User Stream (Conversation) Input
Chatter REST API Response Bodies
Chatter REST API Appendices
PDF

Newer Version Available

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

Clean Input

Defines a clean rule, its type, and the records to clean.
JSON example
1{ 
2"cleanType":"bulk"
3"cleanRuleId":"07ixx000000000U"
4"requestId":"0Ysxx0000000004"
5"entityIds":["003xx000004TnDu", .... ] 
6}
Properties
Name Type Description Required or Optional Available Version
cleanRuleId String The 18-character ID of the clean rule used to clean records. Get the IDs for active clean rules from the Clean Rule Statuses resource. Required 37.0
cleanType String The system-generated type of clean operation used by the clean rule. One of these values:
  • BulkClean—Cleans all existing records applicable to the specified clean rule.
  • Incremental—Cleans only records that do not have a status of In Sync or Reviewed.
  • Manual—Manually cleans records with the specified clean rule.
  • Perpetual—Automatically cleans saved records with the specified clean rule.
 Optional 37.0
entityIds String[] The 18-character IDs of the records to clean using the clean rule. Required 37.0
requestId String The system-generated ID of the clean request. Optional 37.0