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 Favorite

Update a favorite.

Resource

1/ui-api/favorites/${favoriteId}

favoriteId—The ID of a favorite.

Available Version

41.0

HTTP Method

PATCH

Example

This example uses a request body to update a favorite.

1{
2  name: "Red Accounts",
3  sortOrder: 1
4}

Request Parameters

Parameter Name	Type	Description	Required or Optional	Available Version
`name`	String	The name of the favorite.	You must specify either `name` or `sortOrder`. You may specify both.	41.0
`sortOrder`	Integer	The sort order of the favorite, from 1 to N.	You must specify either `name` or `sortOrder`. You may specify both.	41.0

Request Body

Favorite Input

Response Body

Favorite

User Interface API Developer Guide

Update a Favorite