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.

Update a Batch of Favorites

Update all favorites at once. The sort order is updated to the given relative ordering. Any favorites missing from the request body are deleted.

Resource

1/ui-api/favorites/batch

Available Version

41.0

HTTP Method

PUT

Request Body

JSON example

1{
2  favorites: [
3  {
4    id: "0MVR00000004DhnOAE",
5    name: "Q4 Perf"
6  }, { 
7    id: "0MVR00000004DhsOAE"
8  }, {
9    id: "0MVR00000004DiGOAU"
10  }, {
11    id: "0MVR000000001e2OAA",
12    name: "Office Group"
13  }, {
14    id: "0MVR00000004GGlOAM"
15  }}]
16}

Properties

Name	Type	Description	Required or Optional	Available Version
`favorites`	Favorite Batch Input[]	The list of favorites to keep and update.	Required	41.0

Response Body

Favorite Collection

User Interface API Developer Guide

Update a Batch of Favorites