Create a Favorite

Create a favorite.
Resource
/ui-api/favorites
Available Version
41.0
HTTP Method
POST
Example
POST /ui-api/favorites/
{
  name: "Most Important Accounts",
  sortOrder: 1
  target: "00BR0000000tTTwMAM",
  targetType: "ListView"
}
Request Parameters
Name Type Description Required or Optional Available Version
name String The name of the favorite. Optional 41.0
sortOrder Integer The sort order of the favorite, from 1 to N. Optional 41.0
target String The record, API name, or content being favorited. Required 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 41.0
Request Body
Favorite Input
Response Body
Favorite