User Interface API Developer Guide
jNewer Version Available
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 Body
-
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 target String The record, API name, or content being favorited. Required in a POST request. Do not specify in a PATCH request. 41.0 targetType String The type of favorite. One of these values: - ListView—A favorited list view.
- ObjectHome—A favorited object home.
- Record—A favorited record.
- Tab—A favorited tab.
Required in a POST request. Do not specify in a PATCH request. 41.0 - 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 - Response Body
- FavoriteRepresentation