User Interface API Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with User Interface API
User Interface API Features
User Interface API Resources
Records
Actions
Favorites
Create a Favorite
Get a Favorite
Get Favorites
Update a Favorite
Update a Batch of Favorites
Delete a Favorite
Update Usage of a Favorite
Lists
Apps
Get Active Theme
User Interface API Request Bodies
User Interface API Response Bodies
User Interface API Appendices
PDF

Update a Favorite

Update a favorite.
Resource
/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.
{
  name: "Red Accounts",
  sortOrder: 1
}
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