Chatter REST API Developer Guide

Chatter REST API Developer Guide
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Clean Records

Update records with a data integration rule.
Resource
1/clean
Available version
37.0
Requires Chatter
No
HTTP methods
POST
Request body for POST
Root XML tag
<CleanInput>
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 data integration rule used to update records. Get the IDs for active rules from the Clean Rule Statuses resource. Required 37.0
cleanType String The system-generated type of update operation used by the data integration rule. One of these values:
  • BulkClean—Updates all existing records applicable to the specified data integration rule.
  • Incremental—Updates only records that do not have a status of In Sync or Reviewed.
  • Manual—Manually updates records with the specified data integration rule.
  • Perpetual—Automatically updates saved records with the specified data integration rule.
 Optional 37.0
entityIds String[] The 18-character IDs of the records to update using the data integration rule. Required 37.0
requestId String The system-generated ID of the update request. Optional 37.0
Response body for POST
Clean Record Result Collection